From d9c99a29a0d3384c9c3d2adce430f5cb1134ab6a Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 30 Mar 2016 00:56:30 +0200 Subject: Imported Upstream version 1.1.92 --- docs/api/html/NetworkManager.conf.html | 1060 +++++++ docs/api/html/NetworkManager.devhelp2 | 353 ++- docs/api/html/NetworkManager.html | 494 ++++ ...org.freedesktop.NetworkManager.AccessPoint.html | 167 ++ ...rg.freedesktop.NetworkManager.AgentManager.html | 104 + ...eedesktop.NetworkManager.Connection.Active.html | 212 ++ ...org.freedesktop.NetworkManager.DHCP4Config.html | 86 + ...org.freedesktop.NetworkManager.DHCP6Config.html | 86 + ...org.freedesktop.NetworkManager.Device.Adsl.html | 86 + ...reedesktop.NetworkManager.Device.Bluetooth.html | 104 + ...org.freedesktop.NetworkManager.Device.Bond.html | 104 + ...g.freedesktop.NetworkManager.Device.Bridge.html | 104 + ....freedesktop.NetworkManager.Device.Generic.html | 95 + ...freedesktop.NetworkManager.Device.IPTunnel.html | 176 ++ ...eedesktop.NetworkManager.Device.Infiniband.html | 95 + ....freedesktop.NetworkManager.Device.Macvlan.html | 113 + ...rg.freedesktop.NetworkManager.Device.Modem.html | 95 + ...freedesktop.NetworkManager.Device.OlpcMesh.html | 104 + ...org.freedesktop.NetworkManager.Device.Team.html | 104 + ...-org.freedesktop.NetworkManager.Device.Tun.html | 140 + ...org.freedesktop.NetworkManager.Device.Veth.html | 86 + ...org.freedesktop.NetworkManager.Device.Vlan.html | 113 + ...rg.freedesktop.NetworkManager.Device.Vxlan.html | 230 ++ ...rg.freedesktop.NetworkManager.Device.WiMax.html | 213 ++ ...rg.freedesktop.NetworkManager.Device.Wired.html | 122 + ...freedesktop.NetworkManager.Device.Wireless.html | 242 ++ ...dbus-org.freedesktop.NetworkManager.Device.html | 416 +++ ...s-org.freedesktop.NetworkManager.IP4Config.html | 167 ++ ...s-org.freedesktop.NetworkManager.IP6Config.html | 158 ++ .../gdbus-org.freedesktop.NetworkManager.PPP.html | 133 + ...org.freedesktop.NetworkManager.SecretAgent.html | 181 ++ ...desktop.NetworkManager.Settings.Connection.html | 222 ++ ...us-org.freedesktop.NetworkManager.Settings.html | 320 +++ ....freedesktop.NetworkManager.VPN.Connection.html | 122 + ...-org.freedesktop.NetworkManager.VPN.Plugin.html | 392 +++ .../html/gdbus-org.freedesktop.NetworkManager.html | 638 +++++ docs/api/html/index.html | 153 +- docs/api/html/index.sgml | 434 +++ docs/api/html/ix01.html | 685 ++++- docs/api/html/license.html | 6 +- docs/api/html/manpages.html | 49 + docs/api/html/nm-settings-ifcfg-rh.html | 1876 +++++++++++++ docs/api/html/nm-settings-keyfile.html | 525 ++++ docs/api/html/nm-settings.html | 2567 +++++++++++++++++ docs/api/html/nmcli-examples.html | 610 ++++ docs/api/html/ref-dbus.html | 34 - docs/api/html/ref-migrating.html | 540 ---- docs/api/html/ref-settings.html | 30 +- docs/api/html/secrets-flags.html | 8 +- docs/api/html/spec.html | 2931 +------------------- 50 files changed, 14656 insertions(+), 3429 deletions(-) create mode 100644 docs/api/html/NetworkManager.conf.html create mode 100644 docs/api/html/NetworkManager.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WiMax.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html create mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.html create mode 100644 docs/api/html/index.sgml create mode 100644 docs/api/html/manpages.html create mode 100644 docs/api/html/nm-settings-ifcfg-rh.html create mode 100644 docs/api/html/nm-settings-keyfile.html create mode 100644 docs/api/html/nm-settings.html create mode 100644 docs/api/html/nmcli-examples.html delete mode 100644 docs/api/html/ref-dbus.html delete mode 100644 docs/api/html/ref-migrating.html (limited to 'docs/api/html') diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html new file mode 100644 index 00000000..5049ecfe --- /dev/null +++ b/docs/api/html/NetworkManager.conf.html @@ -0,0 +1,1060 @@ + + + + +NetworkManager.conf: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NetworkManager.conf

+

NetworkManager.conf — NetworkManager configuration file

+
+
+

Synopsis

+

/etc/NetworkManager/NetworkManager.conf, + /etc/NetworkManager/conf.d/name.conf, + /usr/lib/NetworkManager/conf.d/name.conf, + /var/lib/NetworkManager/NetworkManager-intern.conf +

+
+
+

Description

+

NetworkManager.conf is the configuration file for NetworkManager. It is used + to set up various aspects of NetworkManager's behavior. The + location of the main file and configuration directories may be changed + through use of the --config, --config-dir, + --system-config-dir, and --intern-config + argument for NetworkManager, respectively. +

+

If a default NetworkManager.conf is + provided by your distribution's packages, you should not modify + it, since your changes may get overwritten by package + updates. Instead, you can add additional .conf + files to the /etc/NetworkManager/conf.d directory. + These will be read in order, with later files overriding earlier ones. + Packages might install further configuration snippets to /usr/lib/NetworkManager/conf.d. + This directory is parsed first, even before NetworkManager.conf. + The loading of a file /usr/lib/NetworkManager/conf.d/name.conf + can be prevented by adding a file /etc/NetworkManager/conf.d/name.conf. + In this case, the file from the etc configuration shadows the file from the + system configuration directory. +

+

+ NetworkManager can overwrite certain user configuration options via D-Bus or other internal + operations. In this case it writes those changes to /var/lib/NetworkManager/NetworkManager-intern.conf. + This file is not intended to be modified by the user, but it is read last and can shadow + user configuration from NetworkManager.conf. +

+
+
+

File Format

+

+ The configuration file format is so-called key file (sort of + ini-style format). It consists of sections (groups) of + key-value pairs. Lines beginning with a '#' and blank lines are + considered comments. Sections are started by a header line + containing the section enclosed in '[' and ']', and ended + implicitly by the start of the next section or the end of the + file. Each key-value pair must be contained in a section. +

+

+ For keys that take a list of devices as their value, you can + specify devices by their MAC addresses or interface names, or + "*" to specify all devices. See the section called “Device List Format” + below. +

+

+ Minimal system settings configuration file looks like this: +

+
+[main]
+plugins=keyfile
+
+

+

+

+ As an extension to the normal keyfile format, you can also + append a value to a previously-set list-valued key by doing: +

+
+plugins+=another-plugin
+plugins-=remove-me
+
+

+

+
+
+

+main section

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

plugins

 +

+ Lists system settings plugin names separated by ','. These + plugins are used to read and write system-wide + connections. When multiple plugins are specified, the + connections are read from all listed plugins. When writing + connections, the plugins will be asked to save the + connection in the order listed here; if the first plugin + cannot write out that connection type (or can't write out + any connections) the next plugin is tried, etc. If none of + the plugins can save the connection, an error is returned + to the user. +

+

+ If NetworkManager defines a distro-specific + network-configuration plugin for your system, then that + will normally be listed here. (See below for the available + plugins.) Note that the keyfile plugin + is always appended to the end of this list (if it doesn't + already appear earlier in the list), so if there is no + distro-specific plugin for your system then you can leave + this key unset and NetworkManager will fall back to using + keyfile. +

+

monitor-connection-files

Whether the configured settings plugin(s) + should set up file monitors and immediately pick up changes + made to connection files while NetworkManager is running. This + is disabled by default; NetworkManager will only read + the connection files at startup, and when explicitly requested + via the ReloadConnections D-Bus call. If this key is set to + 'true', then NetworkManager will reload + connection files any time they changed.

auth-polkit

Whether the system uses PolicyKit for authorization. + If false, all requests will be allowed. If + true, non-root requests are authorized using PolicyKit. + The default value is true. +

dhcp

 +

This key sets up what DHCP client + NetworkManager will use. Allowed values are + dhclient, dhcpcd, and + internal. The dhclient + and dhcpcd options require the indicated + clients to be installed. The internal + option uses a built-in DHCP client which is not currently as + featureful as the external clients.

+

If this key is missing, available DHCP clients are + looked for in this order: dhclient, + dhcpcd, + internal.

+

no-auto-default

 +

Specify devices for which + NetworkManager shouldn't create default wired connection + (Auto eth0). By default, NetworkManager creates a temporary + wired connection for any Ethernet device that is managed and + doesn't have a connection configured. List a device in this + option to inhibit creating the default connection for the + device. May have the special value * to + apply to all devices.

+

When the default wired connection is deleted or saved + to a new persistent connection by a plugin, the device is + added to a list in the file + /var/run/NetworkManager/no-auto-default.state + to prevent creating the default connection for that device + again.

+

See the section called “Device List Format” for the syntax how to + specify a device. +

+

+ Example: +

+
+no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee
+no-auto-default=eth0,eth1
+no-auto-default=*
+
+

+

+

ignore-carrier

 +

+ Specify devices for which NetworkManager will (partially) + ignore the carrier state. Normally, for + device types that support carrier-detect, such as Ethernet + and InfiniBand, NetworkManager will only allow a + connection to be activated on the device if carrier is + present (ie, a cable is plugged in), and it will + deactivate the device if carrier drops for more than a few + seconds. +

+

+ Listing a device here will allow activating connections on + that device even when it does not have carrier, provided + that the connection uses only statically-configured IP + addresses. Additionally, it will allow any active + connection (whether static or dynamic) to remain active on + the device when carrier is lost. +

+

+ Note that the "carrier" property of NMDevices and device D-Bus + interfaces will still reflect the actual device state; it's just + that NetworkManager will not make use of that information. +

+

See the section called “Device List Format” for the syntax how to + specify a device. +

+

assume-ipv6ll-only

 +

+ Specify devices for which NetworkManager will try to + generate a connection based on initial configuration when + the device only has an IPv6 link-local address. +

+

See the section called “Device List Format” for the syntax how to + specify a device. +

+

configure-and-quit

+ When set to 'true', NetworkManager quits after + performing initial network configuration but spawns small helpers + to preserve DHCP leases and IPv6 addresses. This is useful in + environments where network setup is more or less static or it is + desirable to save process time but still handle some dynamic + configurations. When this option is true, + network configuration for WiFi, WWAN, Bluetooth, ADSL, and PPPoE + interfaces cannot be preserved due to their use of external + services, and these devices will be deconfigured when NetworkManager + quits even though other interface's configuration may be preserved. + Also, to preserve DHCP addresses the 'dhcp' option + must be set to 'internal'. The default value of + the 'configure-and-quit' option is + 'false', meaning that NetworkManager will continue + running after initial network configuration and continue responding + to system and hardware events, D-Bus requests, and user commands. +

dns

 +

Set the DNS (resolv.conf) processing mode.

+

default: The default if the key is + not specified. NetworkManager will update + resolv.conf to reflect the nameservers + provided by currently active connections.

+

dnsmasq: NetworkManager will run + dnsmasq as a local caching nameserver, using a "split DNS" + configuration if you are connected to a VPN, and then update + resolv.conf to point to the local + nameserver.

+

unbound: NetworkManager will talk + to unbound and dnssec-triggerd, providing a "split DNS" + configuration with DNSSEC support. The /etc/resolv.conf + will be managed by dnssec-trigger daemon.

+

none: NetworkManager will not + modify resolv.conf.

+

rc-manager

 +

Set the resolv.conf + management mode. The default value depends on how NetworkManager + was built. Regardless of this setting, NetworkManager will + always write resolv.conf to its runtime state directory.

+

none: NetworkManager will symlink + /etc/resolv.conf to its private + resolv.conf file in the runtime state directory.

+

file: NetworkManager will write + /etc/resolv.conf as file.

+

resolvconf: NetworkManager will run + resolvconf to update the DNS configuration.

+

netconfig: NetworkManager will run + netconfig to update the DNS configuration.

+

debug

 +

Comma separated list of options to aid + debugging. This value will be combined with the environment + variable NM_DEBUG. Currently the following + values are supported:

+

+ RLIMIT_CORE: set ulimit -c unlimited + to write out core dumps. Beware, that a core dump can contain + sensitive information such as passwords or configuration settings. +

+

+ fatal-warnings: set g_log_set_always_fatal() + to core dump on warning messages from glib. This is equivalent + to the --g-fatal-warnings command line option. +

+
+
+
+

+keyfile section

+

This section contains keyfile-plugin-specific options, and + is normally only used when you are not using any other + distro-specific plugin.

+

+

+
++++ + + + + + + + + + + + + + + +

hostname

This key is deprecated and has no effect + since the hostname is now stored in /etc/hostname or other + system configuration files according to build options. +

path

The location where keyfiles are read and stored. + This defaults to "/usr/local/etc/NetworkManager/conf.d". +

unmanaged-devices

 +

Set devices that should be ignored by + NetworkManager. +

+

See the section called “Device List Format” for the syntax how to + specify a device. +

+

+ Example: +

+
+unmanaged-devices=interface-name:em4
+unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
+
+

+

+
+

+

+
+
+

+ifupdown section

+

This section contains ifupdown-specific options and thus only + has effect when using the ifupdown plugin.

+

+

+
++++ + + + + +

managed

 +

If set to true, then + interfaces listed in + /etc/network/interfaces are managed by + NetworkManager. If set to false, then + any interface listed in + /etc/network/interfaces will be ignored + by NetworkManager. Remember that NetworkManager controls the + default route, so because the interface is ignored, + NetworkManager may assign the default route to some other + interface.

+

+ The default value is false. +

+
+

+

+
+
+

+logging section

+

This section controls NetworkManager's logging. Any + settings here are overridden by the --log-level + and --log-domains command-line options.

+

+

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

level

The default logging verbosity level. + One of OFF, ERR, + WARN, INFO, + DEBUG, TRACE. The ERR + level logs only critical errors. WARN logs warnings that may + reflect operation. INFO logs various informational messages that + are useful for tracking state and operations. DEBUG enables + verbose logging for debugging purposes. TRACE enables even more + verbose logging then DEBUG level. Subsequent levels also log + all messages from earlier levels; thus setting the log level + to INFO also logs error and warning messages.

domains

 +

The following log domains are available: + PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, + WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, + AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, + INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, + TEAM, CONCHECK, DCB, DISPATCH, AUDIT.

+

In addition, these special domains can be used: NONE, + ALL, DEFAULT, DHCP, IP.

+

You can specify per-domain log level overrides by + adding a colon and a log level to any domain. E.g., + "WIFI:DEBUG,WIFI_SCAN:OFF".

+

backend

The logging backend. Supported values + are "debug", "syslog", + "journal". + "debug" uses syslog and logs to standard error. + If NetworkManager is started in debug mode (--debug) + this option is ignored and "debug" is always used. + Otherwise, the default is "journal". +

audit

Whether the audit records are delivered to + auditd, the audit daemon. If false, audit + records will be sent only to the NetworkManager logging + system. If set to true, they will be also + sent to auditd. The default value is true. +

+

+

+
+
+

+connection section

+

Specify default values for connections. +

+

+ Example: +

+
+[connection]
+ipv6.ip6-privacy=0
+
+

+

+
+

Supported Properties

+

+ Not all properties can be overwritten, only the following + properties are supported to have their default values configured + (see nm-settings(5) for details). + A default value is only consulted if the corresponding per-connection value + explicitly allows for that. +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

connection.autoconnect-slaves

connection.lldp

ethernet.wake-on-lan

ipv4.dad-timeout

ipv4.dhcp-timeout

If left unspecified, the default value for + the interface type is used.

ipv4.route-metric

ipv6.ip6-privacy

If ipv6.ip6-privacy is unset, use the content of + "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback. +

ipv6.route-metric

vpn.timeout

If left unspecified, default value of 60 seconds is used.

wifi.mac-address-randomization

If left unspecified, MAC address randomization is disabled.

wifi.powersave

If left unspecified, the default value + "ignore" will be used.

+

+

+
+
+
+

Sections

+

+ You can configure multiple connection + sections, by having different sections with a name that all start + with "connection". + Example: +

+
+[connection]
+ipv6.ip6-privacy=0
+connection.autoconnect-slaves=1
+vpn.timeout=120
+
+[connection-wifi-wlan0]
+match-device=interface-name:wlan0
+ipv4.route-metric=50
+
+[connection-wifi-other]
+match-device=type:wifi
+ipv4.route-metric=55
+ipv6.ip6-privacy=1
+
+

+

+

+ The sections within one file are considered in order of appearance, with the + exception that the [connection] section is always + considered last. In the example above, this order is [connection-wifi-wlan0], + [connection-wlan-other], and [connection]. + When checking for a default configuration value, the sections are searched until + the requested value is found. + In the example above, "ipv4.route-metric" for wlan0 interface is set to 50, + and for all other Wi-Fi typed interfaces to 55. Also, Wi-Fi devices would have + IPv6 private addresses enabled by default, but other devices would have it disabled. + Note that also "wlan0" gets "ipv6.ip6-privacy=1", because although the section + "[connection-wifi-wlan0]" matches the device, it does not contain that property + and the search continues. +

+

+ When having different sections in multiple files, sections from files that are read + later have higher priority. So within one file the priority of the sections is + top-to-bottom. Across multiple files later definitions take precedence. +

+

+ The following properties further control how a connection section applies. +

+
++++ + + + + + + + + + + +

match-device

An optional device spec that restricts + when the section applies. See the section called “Device List Format” + for the possible values. +

stop-match

An optional boolean value which defaults to + no. If the section matches (based on + match-device), further sections will not be + considered even if the property in question is not present. In + the example above, if [connection-wifi-wlan0] would + have stop-match set to yes, + its ipv6.ip6-privacy value would be + unspecified. +

+

+

+
+
+
+

+connectivity section

+

This section controls NetworkManager's optional connectivity + checking functionality. This allows NetworkManager to detect + whether or not the system can actually access the internet or + whether it is behind a captive portal.

+

+

+
++++ + + + + + + + + + + + + + + +

uri

The URI of a web page to periodically + request when connectivity is being checked. This page + should return the header "X-NetworkManager-Status" with a + value of "online". Alternatively, it's body content should + be set to "NetworkManager is online". The body content + check can be controlled by the response + option. If this option is blank or missing, connectivity + checking is disabled. +

interval

Specified in seconds; controls how often + connectivity is checked when a network connection exists. If + set to 0 connectivity checking is disabled. If missing, the + default is 300 seconds.

response

If set controls what body content + NetworkManager checks for when requesting the URI for + connectivity checking. If missing, defaults to + "NetworkManager is online"

+

+

+
+
+

+global-dns section

+

This section specifies global DNS settings that override + connection-specific configuration.

+

+

+
++++ + + + + + + + + + + +

searches

+ A list of search domains to be used during hostname lookup. +

options

+ A list of of options to be passed to the hostname resolver. +

+

+

+
+
+

+global-dns-domain sections

+

Sections with a name starting with the "global-dns-domain-" + prefix allow to define global DNS configuration for specific + domains. The part of section name after "global-dns-domain-" + specifies the domain name a section applies to. More specific + domains have the precedence over less specific ones and the + default domain is represented by the wildcard "*". A default + domain section is mandatory. +

+

+

+
++++ + + + + + + + + + + +

servers

+ A list of addresses of DNS servers to be used for the given domain. +

options

+ A list of domain-specific DNS options. Not used at the moment. +

+

+

+
+
+

+.config sections

+

This is a special section that contains options which apply + to the configuration file that contains the option. +

+

+

+
++++ + + + + +

enable

 +

+ Defaults to "true". If "false", + the configuration file will be skipped during loading. + Note that the main configuration file NetworkManager.conf + cannot be disabled. +

+
+# always skip loading the config file
+[.config]
+enable=false
+
+

+

+

+ You can also match against the version of NetworkManager. For example + the following are valid configurations: +

+
+# only load on version 1.0.6
+[.config]
+enable=nm-version:1.0.6
+
+# load on all versions 1.0.x, but not 1.2.x
+[.config]
+enable=nm-version:1.0
+
+# only load on versions >= 1.1.6. This does not match
+# with version 1.2.0 or 1.4.4. Only the last digit is considered.
+[.config]
+enable=nm-version-min:1.1.6
+
+# only load on versions >= 1.2. Contrary to the previous
+# example, this also matches with 1.2.0, 1.2.10, 1.4.4, etc.
+[.config]
+enable=nm-version-min:1.2
+
+# Match against the maximum allowed version. The example matches
+# versions 1.2.0, 1.2.2, 1.2.4. Again, only the last version digit
+# is allowed to be smaller. So this would not match match on 1.1.10.
+[.config]
+enable=nm-version-max:1.2.6
+
+

+

+

+ You can also match against the value of the environment variable + NM_CONFIG_ENABLE_TAG, like: +

+
+# always skip loading the file when running NetworkManager with
+# environment variable "NM_CONFIG_ENABLE_TAG=TAG1"
+[.config]
+enable=env:TAG1
+
+

+

+

+ More then one match can be specified. The configuration will be + enabled if one of the predicates matches ("or"). The special prefix "except:" can + be used to negate the match. Note that if one except-predicate + matches, the entire configuration will be disabled. + In other words, a except predicate always wins over other predicates. +

+
+# enable the configuration either when the environment variable
+# is present or the version is at least 1.2.0.
+[.config]
+enable=env:TAG2,nm-version-min:1.2
+
+# enable the configuration for version >= 1.2.0, but disable
+# it when the environment variable is set to "TAG3"
+[.config]
+enable=except:env:TAG3,nm-version-min:1.2
+
+# enable the configuration on >= 1.3, >= 1.2.6, and >= 1.0.16.
+# Useful if a certain feature is only present since those releases.
+[.config]
+enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16
+
+

+

+
+

+

+
+
+

Plugins

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

keyfile

 +

+ The keyfile plugin is the generic + plugin that supports all the connection types and + capabilities that NetworkManager has. It writes files out + in an .ini-style format in + /etc/NetworkManager/system-connections. +

+

+ The stored connection file may contain passwords and + private keys, so it will be made readable only to root, + and the plugin will ignore files that are readable or + writable by any user or group other than root. +

+

+ This plugin is always active, and will automatically be + used to store any connections that aren't supported by any + other active plugin. +

+

ifcfg-rh

+ This plugin is used on the Fedora and Red Hat Enterprise + Linux distributions to read and write configuration from + the standard + /etc/sysconfig/network-scripts/ifcfg-* + files. It currently supports reading Ethernet, Wi-Fi, + InfiniBand, VLAN, Bond, Bridge, and Team connections. + Enabling ifcfg-rh implicitly enables + ibft plugin, if it is available. + This can be disabled by adding no-ibft. +

ifcfg-suse

+ This plugin is deprecated and its selection has no effect. + The keyfile plugin should be used + instead. +

ifupdown

 +

+ This plugin is used on the Debian and Ubuntu + distributions, and reads Ethernet and Wi-Fi connections + from /etc/network/interfaces. +

+

+ This plugin is read-only; any connections (of any type) + added from within NetworkManager when you are using this + plugin will be saved using the keyfile + plugin instead. +

+

ibft, no-ibft

+ This plugin allows to read iBFT configuration (iSCSI Boot Firmware Table). + The configuration is read using /sbin/iscsiadm. Users are expected to + configure iBFT connections via the firmware interfaces. + If ibft support is available, it is automatically enabled after + ifcfg-rh. This can be disabled by no-ibft. + You can also explicitly specify ibft to load the + plugin without ifcfg-rh or to change the plugin order. +

+
+
+

Appendix

+
+

Device List Format

+

+ The configuration options main.no-auto-default, main.ignore-carrier, + and keyfile.unmanaged-devices select devices based on a list of matchings. + Devices can be specified using the following format: +

+

+

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

*

Matches every device.

IFNAME

Case sensitive match of interface name of the device. Globbing is not supported.

HWADDR

Match the MAC address of the device. Globbing is not supported

interface-name:IFNAME, interface-name:~IFNAME

Case sensitive match of interface name of the device. Simple globbing is supported with + * and ?. Ranges and escaping is not supported.

interface-name:=IFNAME

Case sensitive match of interface name of the device. Globbing is disabled and IFNAME + is taken literally.

mac:HWADDR

Match the MAC address of the device. Globbing is not supported

s390-subchannels:HWADDR

Match the device based on the subchannel address. Globbing is not supported

type:TYPE

Match the device type. Valid type names are as reported by "nmcli -f GENERAL.TYPE device show". + Globbing is not supported.

except:SPEC

Negative match of a device. SPEC must be explicitly qualified with + a prefix such as interface-name:. A negative match has higher priority then the positive + matches above.

SPEC[,;]SPEC

 +

Multiple specs can be concatenated with commas or semicolons. The order does not matter as + matches are either inclusive or negative (except:), with negative matches having higher + priority. +

+

Backslash is supported to escape the separators ';' and ',', and to express special + characters such as newline ('\n'), tabulator ('\t'), whitespace ('\s') and backslash ('\\'). The globbing of + interface names cannot be escaped. Whitespace is not a separator but will be trimmed between + two specs (unless escaped as '\s'). +

+
+

+

+

+ Example: +

+
+interface-name:em4
+mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
+interface-name:vboxnet*,except:interface-name:vboxnet2
+*,except:mac:00:22:68:1c:59:b1
+
+

+

+
+
+
+

See Also

+

+ NetworkManager(8), + nmcli(1), + nmcli-examples(5), + nm-online(1), + nm-settings(5), + nm-applet(1), + nm-connection-editor(1) +

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 index 112d9686..d076d1ec 100644 --- a/docs/api/html/NetworkManager.devhelp2 +++ b/docs/api/html/NetworkManager.devhelp2 @@ -1,29 +1,346 @@ - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/api/html/NetworkManager.html b/docs/api/html/NetworkManager.html new file mode 100644 index 00000000..f12e5b55 --- /dev/null +++ b/docs/api/html/NetworkManager.html @@ -0,0 +1,494 @@ + + + + +NetworkManager: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NetworkManager

+

NetworkManager — network management daemon

+
+
+

Synopsis

+

NetworkManager [OPTIONS...]

+
+
+

Description

+

+ The NetworkManager daemon attempts to make networking + configuration and operation as painless and automatic as + possible by managing the primary network connection and other + network interfaces, like Ethernet, WiFi, and Mobile Broadband + devices. NetworkManager will connect any network device when a + connection for that device becomes available, unless that + behavior is disabled. Information about networking is exported + via a D-Bus interface to any interested application, providing a + rich API with which to inspect and control network settings and + operation. +

+
+
+

Dispatcher scripts

+

+ NetworkManager will execute scripts in the + /etc/NetworkManager/dispatcher.d directory or subdirectories in + alphabetical order in response to network events. Each script should + be a regular executable file owned by root. Furthermore, it must not be + writable by group or other, and not setuid. +

+

+ Each script receives two arguments, the first being the interface name of the + device an operation just happened on, and second the action. For device actions, + the interface is the name of the kernel interface suitable for IP configuration. + Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable. + For the hostname action it is always "none". +

+

The actions are:

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pre-up

The interface is connected to the network but is not + yet fully activated. Scripts acting on this event must be placed or + symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d directory, + and NetworkManager will wait for script execution to complete before + indicating to applications that the interface is fully activated. +

up

The interface has been activated.

pre-down

The interface will be deactivated but has not yet been + disconnected from the network. Scripts acting on this event must be + placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d + directory, and NetworkManager will wait for script execution to complete + before disconnecting the interface from its network. Note that this + event is not emitted for forced disconnections, like when carrier is + lost or a wireless signal fades. It is only emitted when there is + an opportunity to cleanly handle a network disconnection event. +

down

+ The interface has been deactivated. +

vpn-pre-up

The VPN is connected to the network but is not yet + fully activated. Scripts acting on this event must be placed or + symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d directory, + and NetworkManager will wait for script execution to complete before + indicating to applications that the VPN is fully activated. +

vpn-up

+ A VPN connection has been activated. +

vpn-pre-down

The VPN will be deactivated but has not yet been + disconnected from the network. Scripts acting on this event must be + placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d + directory, and NetworkManager will wait for script execution to complete + before disconnecting the VPN from its network. Note that this + event is not emitted for forced disconnections, like when the VPN + terminates unexpectedly or general connectivity is lost. It is only + emitted when there is an opportunity to cleanly handle a VPN + disconnection event. +

vpn-down

+ A VPN connection has been deactivated. +

hostname

+ The system hostname has been updated. Use gethostname(2) to retrieve it. + The interface name (first argument) is empty and no environment variable is + set for this action. +

dhcp4-change

+ The DHCPv4 lease has changed (renewed, rebound, etc). +

dhcp6-change

+ The DHCPv6 lease has changed (renewed, rebound, etc). +

+

+ The environment contains more information about the interface and the connection. + The following variables are available for the use in the dispatcher scripts: +

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

CONNECTION_UUID

+ The UUID of the connection profile. +

CONNECTION_ID

+ The name (ID) of the connection profile. +

CONNECTION_DBUS_PATH

+ The NetworkManager D-Bus path of the connection. +

CONNECTION_FILENAME

+ The backing file name of the connection profile (if any). +

CONNECTION_EXTERNAL

+ If "1", this indicates that the connection describes a + network configuration created outside of NetworkManager. +

DEVICE_IFACE

+ The interface name of the control interface of the device. + Depending on the device type, this differs from + DEVICE_IP_IFACE. For example for + ADSL devices, this could be 'atm0' or for WWAN devices + it might be 'ttyUSB0'. +

DEVICE_IP_IFACE

+ The IP interface name of the device. This is the network + interface on which IP addresses and routes will be configured. +

IP4_ADDRESS_N

+ The IPv4 address in the format "address/prefix gateway", where N is a number + from 0 to (# IPv4 addresses - 1). gateway item in this variable is deprecated, + use IP4_GATEWAY instead. +

IP4_NUM_ADDRESSES

+ The variable contains the number of IPv4 addresses the script may expect. +

IP4_GATEWAY

+ The gateway IPv4 address in traditional numbers-and-dots notation. +

IP4_ROUTE_N

+ The IPv4 route in the format "address/prefix next-hop metric", where N is a number + from 0 to (# IPv4 routes - 1). +

IP4_NUM_ROUTES

+ The variable contains the number of IPv4 routes the script may expect. +

IP4_NAMESERVERS

+ The variable contains a space-separated list of the DNS servers. +

IP4_DOMAINS

+ The variable contains a space-separated list of the search domains. +

DHCP4_<dhcp-option-name>

+ If the connection used DHCP for address configuration, the received DHCP + configuration is passed in the environment using standard DHCP + option names, prefixed with "DHCP4_", like "DHCP4_HOST_NAME=foobar". +

IP6_<name> and DHCP6_<name>

+ The same variables as for IPv4 are available for IPv6, but the prefixes are IP6_ + and DHCP6_ instead. +

+

+

+

+ In case of VPN, VPN_IP_IFACE is set, and IP4_*, IP6_* variables with VPN prefix are + exported too, like VPN_IP4_ADDRESS_0, VPN_IP4_NUM_ADDRESSES. +

+

+ Dispatcher scripts are run one at a time, but asynchronously from the main + NetworkManager process, and will be killed if they run for too long. If your script + might take arbitrarily long to complete, you should spawn a child process and have the + parent return immediately. Scripts that are symbolic links pointing inside the + /etc/NetworkManager/dispatcher.d/no-wait.d/ directory are run immediately, without + waiting for the termination of previous scripts, and in parallel. Also beware that + once a script is queued, it will always be run, even if a later event renders it + obsolete. (Eg, if an interface goes up, and then back down again quickly, it is + possible that one or more "up" scripts will be run after the interface has gone down.) +

+
+
+

Options

+

The following options are understood:

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

--version | -V

Print the NetworkManager software version and exit. +

--help | -h

Print NetworkManager's available options and exit. +

--no-daemon | -n

Do not daemonize. +

--debug | -d

Do not daemonize, and direct log output to the + controlling terminal in addition to syslog. +

--pid-file | -p

Specify location of a PID file. The PID file + is used for storing PID of the running process and prevents + running multiple instances. +

--state-file

Specify file for storing state of the + NetworkManager persistently. If not specified, the default + value of /var/lib/NetworkManager/NetworkManager.state is used. +

--config

Specify configuration file to set up various + settings for NetworkManager. If not specified, the default + value of /etc/NetworkManager/NetworkManager.conf is used with + a fallback to the older 'nm-system-settings.conf' if located + in the same directory. See + NetworkManager.conf(5) + for more information on configuration file. +

--plugins

List plugins used to manage system-wide + connection settings. This list has preference over plugins + specified in the configuration file. Currently supported + plugins are: keyfile, ifcfg-rh, + ifcfg-suse, ifupdown. +

--log-level

+ Sets how much information NetworkManager sends to the log destination (usually + syslog's "daemon" facility). By default, only informational, warning, and error + messages are logged. See the section on logging in + NetworkManager.conf(5) + for more information. +

--log-domains

+ A comma-separated list specifying which operations are logged to the log + destination (usually syslog). By default, most domains are logging-enabled. + See the section on logging in + NetworkManager.conf(5) + for more information. +

--print-config

+ Print the NetworkManager configuration to stdout and exit. +

+
+
+

UDEV PROPERTIES

+

+ udev(7) + device manager is used for the network device discovery. The following + property influences how NetworkManager manages the devices: +

+
++++ + + + + +

NM_UNMANAGED

 +

+ No default connection will be created and automatic activation + will not be attempted when this property of a device is set to a + true value ("1" or "true"). You will still be able to attach a + connection to the device manually or observe externally added + configuration such as addresses or routes. +

+

+ Create an udev rule that sets this property to prevent NetworkManager + from interfering with virtual Ethernet device interfaces that are + managed by virtualization tools. +

+
+
+
+

SIGNALS

+

+ NetworkManager process handles the following signals: +

+
++++ + + + + + + + + + + + + + + +

SIGHUP

+ The signal causes a reload of NetworkManager's configuration. + Note that not all configuration parameters can be changed at + runtime and therefore some changes may be applied only after + the next restart of the daemon. The signal also forces a + rewrite of DNS configuration. +

SIGUSR1

+ The signal forces a rewrite of DNS configuration. +

SIGUSR2

+ The signal has no effect at the moment. +

+

+

+
+
+

DEBUGGING

+

+ The following environment variables are supported to help + debugging. When used in conjunction with the + --no-daemon option (thus echoing PPP and DHCP + helper output to stdout) these can quickly help pinpoint the + source of connection issues. Also see the + --log-level and --log-domains + to enable debug logging inside NetworkManager itself. +

+

+ NM_PPP_DEBUG: When set to anything, causes + NetworkManager to turn on PPP debugging in pppd, which logs + all PPP and PPTP frames and client/server exchanges. +

+
+
+

See Also

+

+ NetworkManager.conf(5), + nmcli(1), + nmcli-examples(5), + nm-online(1), + nm-settings(5), + nm-applet(1), + nm-connection-editor(1) + udev(7) +

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html new file mode 100644 index 00000000..555898aa --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html @@ -0,0 +1,167 @@ + + + + +org.freedesktop.NetworkManager.AccessPoint: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.AccessPoint

+

org.freedesktop.NetworkManager.AccessPoint

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Flags       readable   u
+WpaFlags    readable   u
+RsnFlags    readable   u
+Ssid        readable   ay
+Frequency   readable   u
+HwAddress   readable   s
+Mode        readable   u
+MaxBitrate  readable   u
+Strength    readable   y
+LastSeen    readable   i
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Flags" property

+
+Flags  readable   u
+
+

Flags describing the capabilities of the access point.

+
+
+
+

The "WpaFlags" property

+
+WpaFlags  readable   u
+
+

Flags describing the access point's capabilities according to WPA (Wifi Protected Access).

+
+
+
+

The "RsnFlags" property

+
+RsnFlags  readable   u
+
+

Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.

+
+
+
+

The "Ssid" property

+
+Ssid  readable   ay
+
+

The Service Set Identifier identifying the access point.

+
+
+
+

The "Frequency" property

+
+Frequency  readable   u
+
+

The radio channel frequency in use by the access point, in MHz.

+
+
+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

The hardware address (BSSID) of the access point.

+
+
+
+

The "Mode" property

+
+Mode  readable   u
+
+

Describes the operating mode of the access point.

+
+
+
+

The "MaxBitrate" property

+
+MaxBitrate  readable   u
+
+

The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).

+
+
+
+

The "Strength" property

+
+Strength  readable   y
+
+

The current signal quality of the access point, in percent.

+
+
+
+

The "LastSeen" property

+
+LastSeen  readable   i
+
+

The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access point has never been found in scan results.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html new file mode 100644 index 00000000..b1602bcf --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.AgentManager: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.AgentManager

+

org.freedesktop.NetworkManager.AgentManager

+
+
+

Methods

+
+Register                 (IN  s identifier);
+RegisterWithCapabilities (IN  s identifier,
+                          IN  u capabilities);
+Unregister               ();
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The Register() method

+
+Register (IN  s identifier);
+
+

Called by secret Agents to register their ability to provide and save network secrets.

+
++++ + + + + +

IN s identifier:

Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).

+
+
+
+

The RegisterWithCapabilities() method

+
+RegisterWithCapabilities (IN  s identifier,
+                          IN  u capabilities);
+
+

Like Register() but indicates agent capabilities to NetworkManager.

+
++++ + + + + + + + + + + +

IN s identifier:

See the Register() method's identifier argument.

IN u capabilities:

Indicates various agent capabilities to NetworkManager.

+
+
+
+

The Unregister() method

+
+Unregister ();
+
+

Called by secret Agents to notify NetworkManager that they will no longer handle requests for network secrets. Agents are automatically unregistered when they disconnect from D-Bus.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html new file mode 100644 index 00000000..5d4db35f --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html @@ -0,0 +1,212 @@ + + + + +org.freedesktop.NetworkManager.Connection.Active: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Connection.Active

+

org.freedesktop.NetworkManager.Connection.Active

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Connection      readable   o
+SpecificObject  readable   o
+Id              readable   s
+Uuid            readable   s
+Type            readable   s
+Devices         readable   ao
+State           readable   u
+Default         readable   b
+Ip4Config       readable   o
+Dhcp4Config     readable   o
+Default6        readable   b
+Ip6Config       readable   o
+Dhcp6Config     readable   o
+Vpn             readable   b
+Master          readable   o
+
+
+
+

Description

+

Objects that implement the Connection.Active interface represent an attempt to connect to a network using the details provided by a Connection object. The Connection.Active object tracks the life-cycle of the connection attempt and if successful indicates whether the connected network is the "default" or preferred network for access. NetworkManager has the concept of connections, which can be thought of as settings, a profile or a configuration that can be applied on a networking device. Such settings-connections are exposed as D-Bus object and the active-connection expresses this relationship between device and settings-connection. At any time a settings-connection can only be activated on one device and vice versa. However, during activation and deactivation multiple active-connections can reference the same device or settings-connection as they are waiting to be activated or to be deactivated.

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Connection" property

+
+Connection  readable   o
+
+

The path of the connection.

+
+
+
+

The "SpecificObject" property

+
+SpecificObject  readable   o
+
+

A specific object associated with the active connection. This property reflects the specific object used during connection activation, and will not change over the lifetime of the ActiveConnection once set.

+
+
+
+

The "Id" property

+
+Id  readable   s
+
+

The ID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.

+
+
+
+

The "Uuid" property

+
+Uuid  readable   s
+
+

The UUID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.

+
+
+
+

The "Type" property

+
+Type  readable   s
+
+

The type of the connection, provided as a convenience so that clients do not have to retrieve all connection details.

+
+
+
+

The "Devices" property

+
+Devices  readable   ao
+
+

Array of object paths representing devices which are part of this active connection.

+
+
+
+

The "State" property

+
+State  readable   u
+
+

The state of this active connection.

+
+
+
+

The "Default" property

+
+Default  readable   b
+
+

Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.

+
+
+
+

The "Ip4Config" property

+
+Ip4Config  readable   o
+
+

Object path of the Ip4Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

+
+
+
+

The "Dhcp4Config" property

+
+Dhcp4Config  readable   o
+
+

Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

+
+
+
+

The "Default6" property

+
+Default6  readable   b
+
+

Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.

+
+
+
+

The "Ip6Config" property

+
+Ip6Config  readable   o
+
+

Object path of the Ip6Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

+
+
+
+

The "Dhcp6Config" property

+
+Dhcp6Config  readable   o
+
+

Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

+
+
+
+

The "Vpn" property

+
+Vpn  readable   b
+
+

Whether this active connection is also a VPN connection.

+
+
+
+

The "Master" property

+
+Master  readable   o
+
+

The path to the master device if the connection is a slave.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html new file mode 100644 index 00000000..6f8fed9d --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html @@ -0,0 +1,86 @@ + + + + +org.freedesktop.NetworkManager.DHCP4Config: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.DHCP4Config

+

org.freedesktop.NetworkManager.DHCP4Config

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Options  readable   a{sv}
+
+
+
+

Description

+

Options and configuration returned by the IPv4 DHCP server.

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Options" property

+
+Options  readable   a{sv}
+
+

Configuration options returned by a DHCP server, if any.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html new file mode 100644 index 00000000..e1cdb43e --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html @@ -0,0 +1,86 @@ + + + + +org.freedesktop.NetworkManager.DHCP6Config: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.DHCP6Config

+

org.freedesktop.NetworkManager.DHCP6Config

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Options  readable   a{sv}
+
+
+
+

Description

+

Options and configuration returned by the IPv6 DHCP server.

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Options" property

+
+Options  readable   a{sv}
+
+

Configuration options returned by a DHCP server, if any.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html new file mode 100644 index 00000000..3c4c7c7e --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html @@ -0,0 +1,86 @@ + + + + +org.freedesktop.NetworkManager.Device.Adsl: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Adsl

+

org.freedesktop.NetworkManager.Device.Adsl

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Carrier  readable   b
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html new file mode 100644 index 00000000..d9fc09cc --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.Device.Bluetooth: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Bluetooth

+

org.freedesktop.NetworkManager.Device.Bluetooth

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress       readable   s
+Name            readable   s
+BtCapabilities  readable   u
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Bluetooth hardware address of the device.

+
+
+
+

The "Name" property

+
+Name  readable   s
+
+

Bluetooth name of the device.

+
+
+
+

The "BtCapabilities" property

+
+BtCapabilities  readable   u
+
+

Bluetooth capabilities of the device (either DUN or NAP).

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html new file mode 100644 index 00000000..27bfc6f8 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.Device.Bond: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Bond

+

org.freedesktop.NetworkManager.Device.Bond

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress  readable   s
+Carrier    readable   b
+Slaves     readable   ao
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+

The "Slaves" property

+
+Slaves  readable   ao
+
+

Array of object paths representing devices which are currently slaved to this device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html new file mode 100644 index 00000000..83f25082 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.Device.Bridge: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Bridge

+

org.freedesktop.NetworkManager.Device.Bridge

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress  readable   s
+Carrier    readable   b
+Slaves     readable   ao
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+

The "Slaves" property

+
+Slaves  readable   ao
+
+

Array of object paths representing devices which are currently slaved to this device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html new file mode 100644 index 00000000..73fadb87 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html @@ -0,0 +1,95 @@ + + + + +org.freedesktop.NetworkManager.Device.Generic: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Generic

+

org.freedesktop.NetworkManager.Device.Generic

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress        readable   s
+TypeDescription  readable   s
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "TypeDescription" property

+
+TypeDescription  readable   s
+
+

A (non-localized) description of the interface type, if known.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html new file mode 100644 index 00000000..ffc09320 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html @@ -0,0 +1,176 @@ + + + + +org.freedesktop.NetworkManager.Device.IPTunnel: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.IPTunnel

+

org.freedesktop.NetworkManager.Device.IPTunnel

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Mode                readable   u
+Parent              readable   o
+Local               readable   s
+Remote              readable   s
+Ttl                 readable   y
+Tos                 readable   y
+PathMtuDiscovery    readable   b
+InputKey            readable   s
+OutputKey           readable   s
+EncapsulationLimit  readable   y
+FlowLabel           readable   u
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Mode" property

+
+Mode  readable   u
+
+

The tunneling mode.

+
+
+
+

The "Parent" property

+
+Parent  readable   o
+
+

The object path of the parent device.

+
+
+
+

The "Local" property

+
+Local  readable   s
+
+

The local endpoint of the tunnel.

+
+
+
+

The "Remote" property

+
+Remote  readable   s
+
+

The remote endpoint of the tunnel.

+
+
+
+

The "Ttl" property

+
+Ttl  readable   y
+
+

The TTL assigned to tunneled packets. 0 is a special value meaning that packets inherit the TTL value

+
+
+
+

The "Tos" property

+
+Tos  readable   y
+
+

The type of service (IPv4) or traffic class (IPv6) assigned to tunneled packets.

+
+
+
+

The "PathMtuDiscovery" property

+
+PathMtuDiscovery  readable   b
+
+

Whether path MTU discovery is enabled on this tunnel.

+
+
+
+

The "InputKey" property

+
+InputKey  readable   s
+
+

The key used for incoming packets.

+
+
+
+

The "OutputKey" property

+
+OutputKey  readable   s
+
+

The key used for outgoing packets.

+
+
+
+

The "EncapsulationLimit" property

+
+EncapsulationLimit  readable   y
+
+

How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.

+
+
+
+

The "FlowLabel" property

+
+FlowLabel  readable   u
+
+

The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html new file mode 100644 index 00000000..6ba8403e --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html @@ -0,0 +1,95 @@ + + + + +org.freedesktop.NetworkManager.Device.Infiniband: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Infiniband

+

org.freedesktop.NetworkManager.Device.Infiniband

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress  readable   s
+Carrier    readable   b
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html new file mode 100644 index 00000000..ab240f49 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html @@ -0,0 +1,113 @@ + + + + +org.freedesktop.NetworkManager.Device.Macvlan: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Macvlan

+

org.freedesktop.NetworkManager.Device.Macvlan

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Parent     readable   o
+Mode       readable   s
+NoPromisc  readable   b
+Tap        readable   b
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Parent" property

+
+Parent  readable   o
+
+

The object path of the parent device.

+
+
+
+

The "Mode" property

+
+Mode  readable   s
+
+

The macvlan mode, one of "private", "vepa", "bridge", or "passthru".

+
+
+
+

The "NoPromisc" property

+
+NoPromisc  readable   b
+
+

Whether the device is blocked from going into promiscuous mode.

+
+
+
+

The "Tap" property

+
+Tap  readable   b
+
+

Whether the device is a macvtap.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html new file mode 100644 index 00000000..a587a928 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html @@ -0,0 +1,95 @@ + + + + +org.freedesktop.NetworkManager.Device.Modem: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Modem

+

org.freedesktop.NetworkManager.Device.Modem

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+ModemCapabilities    readable   u
+CurrentCapabilities  readable   u
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "ModemCapabilities" property

+
+ModemCapabilities  readable   u
+
+

The generic family of access technologies the modem supports. Not all capabilities are available at the same time however; some modems require a firmware reload or other reinitialization to switch between eg CDMA/EVDO and GSM/UMTS.

+
+
+
+

The "CurrentCapabilities" property

+
+CurrentCapabilities  readable   u
+
+

The generic family of access technologies the modem currently supports without a firmware reload or reinitialization.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html new file mode 100644 index 00000000..24d43344 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.Device.OlpcMesh: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.OlpcMesh

+

org.freedesktop.NetworkManager.Device.OlpcMesh

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress      readable   s
+Companion      readable   o
+ActiveChannel  readable   u
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

Emitted when the wireless device's properties changed.

+
++++ + + + + +

a{sv} properties:

A dictionary containing the FIXME: check changed parameters.

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

The hardware address of the device.

+
+
+
+

The "Companion" property

+
+Companion  readable   o
+
+

The object path of the companion device.

+
+
+
+

The "ActiveChannel" property

+
+ActiveChannel  readable   u
+
+

The currently active channel.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html new file mode 100644 index 00000000..bda719d3 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html @@ -0,0 +1,104 @@ + + + + +org.freedesktop.NetworkManager.Device.Team: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Team

+

org.freedesktop.NetworkManager.Device.Team

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress  readable   s
+Carrier    readable   b
+Slaves     readable   ao
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+

The "Slaves" property

+
+Slaves  readable   ao
+
+

Array of object paths representing devices which are currently slaved to this device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html new file mode 100644 index 00000000..4815cf6e --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html @@ -0,0 +1,140 @@ + + + + +org.freedesktop.NetworkManager.Device.Tun: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Tun

+

org.freedesktop.NetworkManager.Device.Tun

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Owner       readable   x
+Group       readable   x
+Mode        readable   s
+NoPi        readable   b
+VnetHdr     readable   b
+MultiQueue  readable   b
+HwAddress   readable   s
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Owner" property

+
+Owner  readable   x
+
+

The uid of the tunnel owner, or -1 if it has no owner.

+
+
+
+

The "Group" property

+
+Group  readable   x
+
+

The gid of the tunnel group, or -1 if it has no owner.

+
+
+
+

The "Mode" property

+
+Mode  readable   s
+
+

The tunnel mode, either "tun" or "tap".

+
+
+
+

The "NoPi" property

+
+NoPi  readable   b
+
+

The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to the tunnel packets.

+
+
+
+

The "VnetHdr" property

+
+VnetHdr  readable   b
+
+

The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a virtio network header.

+
+
+
+

The "MultiQueue" property

+
+MultiQueue  readable   b
+
+

The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap device multiple times, for multiple send/receive queues.

+
+
+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html new file mode 100644 index 00000000..6bdc741f --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html @@ -0,0 +1,86 @@ + + + + +org.freedesktop.NetworkManager.Device.Veth: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Veth

+

org.freedesktop.NetworkManager.Device.Veth

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Peer  readable   o
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Peer" property

+
+Peer  readable   o
+
+

The object path of the device's peer.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html new file mode 100644 index 00000000..75d564bb --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html @@ -0,0 +1,113 @@ + + + + +org.freedesktop.NetworkManager.Device.Vlan: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Vlan

+

org.freedesktop.NetworkManager.Device.Vlan

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress  readable   s
+Carrier    readable   b
+Parent     readable   o
+VlanId     readable   u
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+

The "Parent" property

+
+Parent  readable   o
+
+

Object path of the parent device of this VLAN device.

+
+
+
+

The "VlanId" property

+
+VlanId  readable   u
+
+

The VLAN ID of this VLAN interface.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html new file mode 100644 index 00000000..ec4a48d4 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html @@ -0,0 +1,230 @@ + + + + +org.freedesktop.NetworkManager.Device.Vxlan: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Vxlan

+

org.freedesktop.NetworkManager.Device.Vxlan

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Parent      readable   o
+HwAddress   readable   s
+Id          readable   u
+Group       readable   s
+Local       readable   s
+Tos         readable   y
+Ttl         readable   y
+Learning    readable   b
+Ageing      readable   u
+Limit       readable   u
+DstPort     readable   q
+SrcPortMin  readable   q
+SrcPortMax  readable   q
+Proxy       readable   b
+Rsc         readable   b
+L2miss      readable   b
+L3miss      readable   b
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Parent" property

+
+Parent  readable   o
+
+

The object path of the parent device (if the VXLAN is not purely internal to this host).

+
+
+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "Id" property

+
+Id  readable   u
+
+

The VXLAN Network Identifier (VNI).

+
+
+
+

The "Group" property

+
+Group  readable   s
+
+

The IP (v4 or v6) multicast group used to communicate with other physical hosts on this VXLAN.

+
+
+
+

The "Local" property

+
+Local  readable   s
+
+

The local IPv4 or IPv6 address to use when sending VXLAN packets to other physical hosts.

+
+
+
+

The "Tos" property

+
+Tos  readable   y
+
+

The value to use in the IP ToS field for VXLAN packets sent to other physical hosts.

+
+
+
+

The "Ttl" property

+
+Ttl  readable   y
+
+

The value to use in the IP TTL field for VXLAN packets sent to other physical hosts.

+
+
+
+

The "Learning" property

+
+Learning  readable   b
+
+

True if the VXLAN dynamically learns remote IP addresses.

+
+
+
+

The "Ageing" property

+
+Ageing  readable   u
+
+

The interval in seconds at which the kernel purges stale cached addresses.

+
+
+
+

The "Limit" property

+
+Limit  readable   u
+
+

The maximum number of entries that can be added to the VXLAN's forwarding table.

+
+
+
+

The "DstPort" property

+
+DstPort  readable   q
+
+

Destination port for outgoing VXLAN packets.

+
+
+
+

The "SrcPortMin" property

+
+SrcPortMin  readable   q
+
+

The lowest source port number to use for outgoing VXLAN packets.

+
+
+
+

The "SrcPortMax" property

+
+SrcPortMax  readable   q
+
+

The highest source port number to use for outgoing VXLAN packets.

+
+
+
+

The "Proxy" property

+
+Proxy  readable   b
+
+

True if the VXLAN is implementing DOVE ARP proxying for remote clients.

+
+
+
+

The "Rsc" property

+
+Rsc  readable   b
+
+

True if the VXLAN is implementing DOVE route short-circuiting of known remote IP addresses.

+
+
+
+

The "L2miss" property

+
+L2miss  readable   b
+
+

True if the VXLAN will emit netlink notifications of L2 switch misses.

+
+
+
+

The "L3miss" property

+
+L3miss  readable   b
+
+

True if the VXLAN will emit netlink notifications of L3 switch misses.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WiMax.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WiMax.html new file mode 100644 index 00000000..3ef7947b --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WiMax.html @@ -0,0 +1,213 @@ + + + + +org.freedesktop.NetworkManager.Device.WiMax: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.WiMax

+

org.freedesktop.NetworkManager.Device.WiMax

+
+
+

Methods

+
+GetNspList (OUT ao nsps);
+
+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+NspAdded          (o     nsp);
+NspRemoved        (o     nsp);
+
+
+
+

Properties

+
+Nsps             readable   ao
+HwAddress        readable   s
+CenterFrequency  readable   u
+Rssi             readable   i
+Cinr             readable   i
+TxPower          readable   i
+Bsid             readable   s
+ActiveNsp        readable   o
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The GetNspList() method

+
+GetNspList (OUT ao nsps);
+
+

Get the list of NSPs visible to this device.

+
++++ + + + + +

OUT ao nsps:

List of NSP object paths

+
+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

Emitted when the WiMax device's properties changed.

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values.

+
+
+
+

The "NspAdded" signal

+
+NspAdded (o nsp);
+
+

Emitted when a new NSP is found by the device.

+
++++ + + + + +

o nsp:

The object path of the newly found NSP.

+
+
+
+

The "NspRemoved" signal

+
+NspRemoved (o nsp);
+
+

Emitted when an NSP disappears from view of the device.

+
++++ + + + + +

o nsp:

The object path of the NSP that has disappeared.

+
+
+
+

Property Details

+
+

The "Nsps" property

+
+Nsps  readable   ao
+
+

List of object paths of Network Service Providers (NSPs) visible to this WiMAX device.

+
+
+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Hardware address of the device.

+
+
+
+

The "CenterFrequency" property

+
+CenterFrequency  readable   u
+
+

Center frequency (in KHz) of the radio channel the device is using to communicate with the network when connected. Has no meaning when the device is not connected.

+
+
+
+

The "Rssi" property

+
+Rssi  readable   i
+
+

RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the device is not connected.

+
+
+
+

The "Cinr" property

+
+Cinr  readable   i
+
+

CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no meaning when the device is not connected.

+
+
+
+

The "TxPower" property

+
+TxPower  readable   i
+
+

Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 dBm. Has no meaning when the device is not connected.

+
+
+
+

The "Bsid" property

+
+Bsid  readable   s
+
+

The ID of the serving base station as received from the network. Has no meaning when the device is not connected.

+
+
+
+

The "ActiveNsp" property

+
+ActiveNsp  readable   o
+
+

Object path of the NSP currently used by the WiMax device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html new file mode 100644 index 00000000..09de05da --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html @@ -0,0 +1,122 @@ + + + + +org.freedesktop.NetworkManager.Device.Wired: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Wired

+

org.freedesktop.NetworkManager.Device.Wired

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+HwAddress        readable   s
+PermHwAddress    readable   s
+Speed            readable   u
+S390Subchannels  readable   as
+Carrier          readable   b
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

Active hardware address of the device.

+
+
+
+

The "PermHwAddress" property

+
+PermHwAddress  readable   s
+
+

Permanent hardware address of the device.

+
+
+
+

The "Speed" property

+
+Speed  readable   u
+
+

Design speed of the device, in megabits/second (Mb/s).

+
+
+
+

The "S390Subchannels" property

+
+S390Subchannels  readable   as
+
+

Array of S/390 subchannels for S/390 or z/Architecture devices.

+
+
+
+

The "Carrier" property

+
+Carrier  readable   b
+
+

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html new file mode 100644 index 00000000..3230bac7 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html @@ -0,0 +1,242 @@ + + + + +org.freedesktop.NetworkManager.Device.Wireless: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device.Wireless

+

org.freedesktop.NetworkManager.Device.Wireless

+
+
+

Methods

+
+GetAccessPoints    (OUT ao    access_points);
+GetAllAccessPoints (OUT ao    access_points);
+RequestScan        (IN  a{sv} options);
+
+
+
+

Signals

+
+PropertiesChanged  (a{sv} properties);
+AccessPointAdded   (o     access_point);
+AccessPointRemoved (o     access_point);
+
+
+
+

Properties

+
+HwAddress             readable   s
+PermHwAddress         readable   s
+Mode                  readable   u
+Bitrate               readable   u
+AccessPoints          readable   ao
+ActiveAccessPoint     readable   o
+WirelessCapabilities  readable   u
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The GetAccessPoints() method

+
+GetAccessPoints (OUT ao access_points);
+
+

DEPRECATED. Get the list of access points visible to this device. Note that this list does not include access points which hide their SSID. To retrieve a list of all access points (including hidden ones) use the GetAllAccessPoints() method.

+
++++ + + + + +

OUT ao access_points:

List of access point object paths.

+
+
+
+

The GetAllAccessPoints() method

+
+GetAllAccessPoints (OUT ao access_points);
+
+

Get the list of all access points visible to this device, including hidden ones for which the SSID is not yet known.

+
++++ + + + + +

OUT ao access_points:

List of access point object paths.

+
+
+
+

The RequestScan() method

+
+RequestScan (IN  a{sv} options);
+
+

Request the device to scan

+
++++ + + + + +

IN a{sv} options:

Options of scan. Currently 'ssids' option with value of "aay" type is supported.

+
+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

Emitted when the wireless device's properties changed.

+
++++ + + + + +

a{sv} properties:

A dictionary containing the FIXME: check changed parameters.

+
+
+
+

The "AccessPointAdded" signal

+
+AccessPointAdded (o access_point);
+
+

Emitted when a new access point is found by the device.

+
++++ + + + + +

o access_point:

The object path of the newly found access point.

+
+
+
+

The "AccessPointRemoved" signal

+
+AccessPointRemoved (o access_point);
+
+

Emitted when an access point disappears from view of the device.

+
++++ + + + + +

o access_point:

The object path of the access point that has disappeared.

+
+
+
+

Property Details

+
+

The "HwAddress" property

+
+HwAddress  readable   s
+
+

The active hardware address of the device.

+
+
+
+

The "PermHwAddress" property

+
+PermHwAddress  readable   s
+
+

The permanent hardware address of the device.

+
+
+
+

The "Mode" property

+
+Mode  readable   u
+
+

The operating mode of the wireless device.

+
+
+
+

The "Bitrate" property

+
+Bitrate  readable   u
+
+

The bit rate currently used by the wireless device, in kilobits/second (Kb/s).

+
+
+
+

The "AccessPoints" property

+
+AccessPoints  readable   ao
+
+

List of object paths of access point visible to this wireless device.

+
+
+
+

The "ActiveAccessPoint" property

+
+ActiveAccessPoint  readable   o
+
+

Object path of the access point currently used by the wireless device.

+
+
+
+

The "WirelessCapabilities" property

+
+WirelessCapabilities  readable   u
+
+

The capabilities of the wireless device.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html new file mode 100644 index 00000000..ee7203c5 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html @@ -0,0 +1,416 @@ + + + + +org.freedesktop.NetworkManager.Device: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Device

+

org.freedesktop.NetworkManager.Device

+
+
+

Methods

+
+Reapply              (IN  a{sa{sv}} connection,
+                      IN  t         version_id,
+                      IN  u         flags);
+GetAppliedConnection (IN  u         flags,
+                      OUT a{sa{sv}} connection,
+                      OUT t         version_id);
+Disconnect           ();
+Delete               ();
+
+
+
+

Signals

+
+StateChanged (u new_state,
+              u old_state,
+              u reason);
+
+
+
+

Properties

+
+Udi                   readable   s
+Interface             readable   s
+IpInterface           readable   s
+Driver                readable   s
+DriverVersion         readable   s
+FirmwareVersion       readable   s
+Capabilities          readable   u
+Ip4Address            readable   u
+State                 readable   u
+StateReason           readable   (uu)
+ActiveConnection      readable   o
+Ip4Config             readable   o
+Dhcp4Config           readable   o
+Ip6Config             readable   o
+Dhcp6Config           readable   o
+Managed               readwrite  b
+Autoconnect           readwrite  b
+FirmwareMissing       readable   b
+NmPluginMissing       readable   b
+DeviceType            readable   u
+AvailableConnections  readable   ao
+PhysicalPortId        readable   s
+Mtu                   readable   u
+Metered               readable   u
+LldpNeighbors         readable   aa{sv}
+Real                  readable   b
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The Reapply() method

+
+Reapply (IN  a{sa{sv}} connection,
+         IN  t         version_id,
+         IN  u         flags);
+
+

Attempts to update the configuration of a device without deactivating it. NetworkManager has the concept of connections, which are profiles that contain the configuration for a networking device. Those connections are exposed via D-Bus as individual objects that can be created, modified and deleted. When activating such a settings-connection on a device, the settings-connection is cloned to become an applied-connection and used to configure the device (see GetAppliedConnection). Subsequent modification of the settings-connection don't propagate automatically to the device's applied-connection (with exception of the firewall-zone and the metered property). For the changes to take effect, you can either re-activate the settings-connection, or call Reapply. The Reapply call allows you to directly update the applied-connection and reconfigure the device. Reapply can also be useful if the currently applied-connection is equal to the connection that is about to be reapplied. This allows to reconfigure the device and revert external changes like removing or adding an IP address (which NetworkManager doesn't revert automatically because it is assumed that the user made these changes intentionally outside of NetworkManager). Reapply can make the applied-connection different from the settings-connection, just like updating the settings-connection can make them different.

+
++++ + + + + + + + + + + + + + + +

IN a{sa{sv}} connection:

The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.

IN t version_id:

If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.

IN u flags:

Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.

+
+
+
+

The GetAppliedConnection() method

+
+GetAppliedConnection (IN  u         flags,
+                      OUT a{sa{sv}} connection,
+                      OUT t         version_id);
+
+

Get the currently applied connection on the device. This is a snapshot of the last activated connection on the device, that is the configuration that is currently applied on the device. Usually this is the same as GetSettings of the referenced settings connection. However, it can differ if the settings connection was subsequently modified or the applied connection was modified by Reapply. The applied connection is set when activating a device or when calling Reapply.

+
++++ + + + + + + + + + + + + + + +

IN u flags:

Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.

OUT a{sa{sv}} connection:

The effective connection settings that the connection has currently applied.

OUT t version_id:

The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.

+
+
+
+

The Disconnect() method

+
+Disconnect ();
+
+

Disconnects a device and prevents the device from automatically activating further connections without user intervention.

+
+
+
+

The Delete() method

+
+Delete ();
+
+

Deletes a software device from NetworkManager and removes the interface from the system. The method returns an error when called for a hardware device.

+
+
+
+

Signal Details

+
+

The "StateChanged" signal

+
+StateChanged (u new_state,
+              u old_state,
+              u reason);
+
+

+
++++ + + + + + + + + + + + + + + +

u new_state:

The new state of the device.

u old_state:

The previous state of the device.

u reason:

A reason for the state transition.

+
+
+
+

Property Details

+
+

The "Udi" property

+
+Udi  readable   s
+
+

Operating-system specific transient device hardware identifier. This is an opaque string representing the underlying hardware for the device, and shouldn't be used to keep track of individual devices. For some device types (Bluetooth, Modems) it is an identifier used by the hardware service (ie bluez or ModemManager) to refer to that device, and client programs use it get additional information from those services which NM does not provide. The Udi is not guaranteed to be consistent across reboots or hotplugs of the hardware. If you're looking for a way to uniquely track each device in your application, use the object path. If you're looking for a way to track a specific piece of hardware across reboot or hotplug, use a MAC address or USB serial number.

+
+
+
+

The "Interface" property

+
+Interface  readable   s
+
+

The name of the device's control (and often data) interface.

+
+
+
+

The "IpInterface" property

+
+IpInterface  readable   s
+
+

The name of the device's data interface when available. This property may not refer to the actual data interface until the device has successfully established a data connection, indicated by the device's State becoming ACTIVATED.

+
+
+
+

The "Driver" property

+
+Driver  readable   s
+
+

The driver handling the device.

+
+
+
+

The "DriverVersion" property

+
+DriverVersion  readable   s
+
+

The version of the driver handling the device.

+
+
+
+

The "FirmwareVersion" property

+
+FirmwareVersion  readable   s
+
+

The firmware version for the device.

+
+
+
+

The "Capabilities" property

+
+Capabilities  readable   u
+
+

Flags describing the capabilities of the device.

+
+
+
+

The "Ip4Address" property

+
+Ip4Address  readable   u
+
+

DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.

+
+
+
+

The "State" property

+
+State  readable   u
+
+

The current state of the device.

+
+
+
+

The "StateReason" property

+
+StateReason  readable   (uu)
+
+

The current state and reason for changing to that state.

+
+
+
+

The "ActiveConnection" property

+
+ActiveConnection  readable   o
+
+

Object path of an ActiveConnection object that "owns" this device during activation. The ActiveConnection object tracks the life-cycle of a connection to a specific network and implements the org.freedesktop.NetworkManager.Connection.Active D-Bus interface.

+
+
+
+

The "Ip4Config" property

+
+Ip4Config  readable   o
+
+

Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

+
+
+
+

The "Dhcp4Config" property

+
+Dhcp4Config  readable   o
+
+

Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

+
+
+
+

The "Ip6Config" property

+
+Ip6Config  readable   o
+
+

Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

+
+
+
+

The "Dhcp6Config" property

+
+Dhcp6Config  readable   o
+
+

Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

+
+
+
+

The "Managed" property

+
+Managed  readwrite  b
+
+

Whether or not this device is managed by NetworkManager. Setting this property has a similar effect to configuring the device as unmanaged via the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to this value are not persistent and lost after NetworkManager restart.

+
+
+
+

The "Autoconnect" property

+
+Autoconnect  readwrite  b
+
+

If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual intervention is required before the device will automatically connect to a known network, such as activating a connection using the device, or setting this property to TRUE. This property cannot be set to TRUE for default-unmanaged devices, since they never autoconnect.

+
+
+
+

The "FirmwareMissing" property

+
+FirmwareMissing  readable   b
+
+

If TRUE, indicates the device is likely missing firmware necessary for its operation.

+
+
+
+

The "NmPluginMissing" property

+
+NmPluginMissing  readable   b
+
+

If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured.

+
+
+
+

The "DeviceType" property

+
+DeviceType  readable   u
+
+

The general type of the network device; ie Ethernet, WiFi, etc.

+
+
+
+

The "AvailableConnections" property

+
+AvailableConnections  readable   ao
+
+

An array of object paths of every configured connection that is currently 'available' through this device.

+
+
+
+

The "PhysicalPortId" property

+
+PhysicalPortId  readable   s
+
+

If non-empty, an (opaque) indicator of the physical network port associated with the device. This can be used to recognize when two seemingly-separate hardware devices are actually just different virtual interfaces to the same physical port.

+
+
+
+

The "Mtu" property

+
+Mtu  readable   u
+
+

The device MTU (maximum transmission unit).

+
+
+
+

The "Metered" property

+
+Metered  readable   u
+
+

Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers.

+
+
+
+

The "LldpNeighbors" property

+
+LldpNeighbors  readable   aa{sv}
+
+

Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV names to variant boxed values.

+
+
+
+

The "Real" property

+
+Real  readable   b
+
+

True if the device exists, or False for placeholder devices that do not yet exist but could be automatically created by NetworkManager if one of their AvailableConnections was activated.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html new file mode 100644 index 00000000..88aabf84 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html @@ -0,0 +1,167 @@ + + + + +org.freedesktop.NetworkManager.IP4Config: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.IP4Config

+

org.freedesktop.NetworkManager.IP4Config

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Addresses    readable   aau
+AddressData  readable   aa{sv}
+Gateway      readable   s
+Routes       readable   aau
+RouteData    readable   aa{sv}
+Nameservers  readable   au
+Domains      readable   as
+Searches     readable   as
+DnsOptions   readable   as
+WinsServers  readable   au
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Addresses" property

+
+Addresses  readable   aau
+
+

Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each array are in network byte order. Essentially: [(addr, prefix, gateway), (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway

+
+
+
+

The "AddressData" property

+
+AddressData  readable   aa{sv}
+
+

Array of IP address data objects. All addresses will include "address" (an IP address string), and "prefix" (a uint). Some addresses may include additional attributes.

+
+
+
+

The "Gateway" property

+
+Gateway  readable   s
+
+

The gateway in use.

+
+
+
+

The "Routes" property

+
+Routes  readable   aau
+
+

Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple are in network byte order. 'route' and 'next hop' are IPv4 addresses, while prefix and metric are simple unsigned integers. Essentially: [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...] Deprecated: use RouteData

+
+
+
+

The "RouteData" property

+
+RouteData  readable   aa{sv}
+
+

Array of IP route data objects. All routes will include "dest" (an IP address string) and "prefix" (a uint). Some routes may include "next-hop" (an IP address string), "metric" (a uint), and additional attributes.

+
+
+
+

The "Nameservers" property

+
+Nameservers  readable   au
+
+

The nameservers in use.

+
+
+
+

The "Domains" property

+
+Domains  readable   as
+
+

A list of domains this address belongs to.

+
+
+
+

The "Searches" property

+
+Searches  readable   as
+
+

A list of dns searches.

+
+
+
+

The "DnsOptions" property

+
+DnsOptions  readable   as
+
+

A list of DNS options that modify the behavior of the DNS resolver. See resolv.conf(5) manual page for the list of supported options.

+
+
+
+

The "WinsServers" property

+
+WinsServers  readable   au
+
+

The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html new file mode 100644 index 00000000..b369e2ab --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html @@ -0,0 +1,158 @@ + + + + +org.freedesktop.NetworkManager.IP6Config: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.IP6Config

+

org.freedesktop.NetworkManager.IP6Config

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Addresses    readable   a(ayuay)
+AddressData  readable   aa{sv}
+Gateway      readable   s
+Routes       readable   a(ayuayu)
+RouteData    readable   aa{sv}
+Nameservers  readable   aay
+Domains      readable   as
+Searches     readable   as
+DnsOptions   readable   as
+
+
+
+

Description

+

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

Property Details

+
+

The "Addresses" property

+
+Addresses  readable   a(ayuay)
+
+

Array of tuples of IPv6 address/prefix/gateway. Deprecated: use AddressData and Gateway.

+
+
+
+

The "AddressData" property

+
+AddressData  readable   aa{sv}
+
+

Array of IP address data objects. All addresses will include "address" (an IP address string), and "prefix" (a uint). Some addresses may include additional attributes.

+
+
+
+

The "Gateway" property

+
+Gateway  readable   s
+
+

The gateway in use.

+
+
+
+

The "Routes" property

+
+Routes  readable   a(ayuayu)
+
+

Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData

+
+
+
+

The "RouteData" property

+
+RouteData  readable   aa{sv}
+
+

Array of IP route data objects. All routes will include "dest" (an IP address string) and "prefix" (a uint). Some routes may include "next-hop" (an IP address string), "metric" (a uint), and additional attributes.

+
+
+
+

The "Nameservers" property

+
+Nameservers  readable   aay
+
+

The nameservers in use.

+
+
+
+

The "Domains" property

+
+Domains  readable   as
+
+

A list of domains this address belongs to.

+
+
+
+

The "Searches" property

+
+Searches  readable   as
+
+

A list of dns searches.

+
+
+
+

The "DnsOptions" property

+
+DnsOptions  readable   as
+
+

A list of DNS options that modify the behavior of the DNS resolver. See resolv.conf(5) manual page for the list of supported options.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html new file mode 100644 index 00000000..a8466a8e --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html @@ -0,0 +1,133 @@ + + + + +org.freedesktop.NetworkManager.PPP: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.PPP

+

org.freedesktop.NetworkManager.PPP

+
+
+

Methods

+
+NeedSecrets  (OUT s     username,
+              OUT s     password);
+SetIp4Config (IN  a{sv} config);
+SetIp6Config (IN  a{sv} config);
+SetState     (IN  u     state);
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The NeedSecrets() method

+
+NeedSecrets (OUT s username,
+             OUT s password);
+
+

+
++++ + + + + + + + + + + +

OUT s username:

OUT s password:

+
+
+
+

The SetIp4Config() method

+
+SetIp4Config (IN  a{sv} config);
+
+

+
++++ + + + + +

IN a{sv} config:

+
+
+
+

The SetIp6Config() method

+
+SetIp6Config (IN  a{sv} config);
+
+

+
++++ + + + + +

IN a{sv} config:

+
+
+
+

The SetState() method

+
+SetState (IN  u state);
+
+

+
++++ + + + + +

IN u state:

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html new file mode 100644 index 00000000..d160c1a1 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html @@ -0,0 +1,181 @@ + + + + +org.freedesktop.NetworkManager.SecretAgent: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.SecretAgent

+

org.freedesktop.NetworkManager.SecretAgent

+
+
+

Methods

+
+GetSecrets       (IN  a{sa{sv}} connection,
+                  IN  o         connection_path,
+                  IN  s         setting_name,
+                  IN  as        hints,
+                  IN  u         flags,
+                  OUT a{sa{sv}} secrets);
+CancelGetSecrets (IN  o         connection_path,
+                  IN  s         setting_name);
+SaveSecrets      (IN  a{sa{sv}} connection,
+                  IN  o         connection_path);
+DeleteSecrets    (IN  a{sa{sv}} connection,
+                  IN  o         connection_path);
+
+
+
+

Description

+

Private D-Bus interface used by secret agents that store and provide secrets to NetworkManager. If an agent provides secrets to NetworkManager as part of connection creation, and the some of those secrets are "agent owned" the agent should store those secrets itself and should not expect its SaveSecrets() method to be called. SaveSecrets() will be called eg if some program other than the agent itself (like a connection editor) changes the secrets out of band. The agent should implement this D-Bus interface on an object with the path /org/freedesktop/NetworkManager/SecretAgent.

+
+
+

Method Details

+
+

The GetSecrets() method

+
+GetSecrets (IN  a{sa{sv}} connection,
+            IN  o         connection_path,
+            IN  s         setting_name,
+            IN  as        hints,
+            IN  u         flags,
+            OUT a{sa{sv}} secrets);
+
+

Retrieve and return stored secrets, if any, or request new secrets from the agent's user. If user interaction is allowed and the user enters new secrets, the agent is expected to save the new secrets to persistent storage (if the secret's flags include AGENT_OWNED) as NetworkManager will not send these secrets back to the same agent via a SaveSecrets() call. If the user canceled any interaction, the agent should return the UserCanceled error (see below).

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

IN a{sa{sv}} connection:

Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.

IN o connection_path:

Object path of the connection for which secrets are being requested.

IN s setting_name:

Setting name for which secrets are being requested.

IN as hints:

Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".

IN u flags:

Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.

OUT a{sa{sv}} secrets:

Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.

+
+
+
+

The CancelGetSecrets() method

+
+CancelGetSecrets (IN  o connection_path,
+                  IN  s setting_name);
+
+

Cancel a pending GetSecrets request for secrets of the given connection. Any GetSecrets request with the same 'connection_path' and 'setting_name' that are given in a CancelGetSecrets request should be canceled.

+
++++ + + + + + + + + + + +

IN o connection_path:

Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.

IN s setting_name:

Setting name for which secrets for this connection were originally being requested.

+
+
+
+

The SaveSecrets() method

+
+SaveSecrets (IN  a{sa{sv}} connection,
+             IN  o         connection_path);
+
+

Save given secrets to backing storage.

+
++++ + + + + + + + + + + +

IN a{sa{sv}} connection:

Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.

IN o connection_path:

Object path of the connection for which the agent should save secrets to backing storage.

+
+
+
+

The DeleteSecrets() method

+
+DeleteSecrets (IN  a{sa{sv}} connection,
+               IN  o         connection_path);
+
+

Delete secrets from backing storage.

+
++++ + + + + + + + + + + +

IN a{sa{sv}} connection:

Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.

IN o connection_path:

Object path of the connection for which the agent should delete secrets from backing storage.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html new file mode 100644 index 00000000..db2a7d57 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html @@ -0,0 +1,222 @@ + + + + +org.freedesktop.NetworkManager.Settings.Connection: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Settings.Connection

+

org.freedesktop.NetworkManager.Settings.Connection

+
+
+

Methods

+
+Update        (IN  a{sa{sv}} properties);
+UpdateUnsaved (IN  a{sa{sv}} properties);
+Delete        ();
+GetSettings   (OUT a{sa{sv}} settings);
+GetSecrets    (IN  s         setting_name,
+               OUT a{sa{sv}} secrets);
+ClearSecrets  ();
+Save          ();
+
+
+
+

Signals

+
+Updated           ();
+Removed           ();
+PropertiesChanged (a{sv} properties);
+
+
+
+

Properties

+
+Unsaved  readable   b
+
+
+
+

Description

+

Represents a single network connection configuration.

+
+
+

Method Details

+
+

The Update() method

+
+Update (IN  a{sa{sv}} properties);
+
+

Update the connection with new settings and properties (replacing all previous settings and properties) and save the connection to disk. Secrets may be part of the update request, and will be either stored in persistent storage or sent to a Secret Agent for storage, depending on the flags associated with each secret.

+
++++ + + + + +

IN a{sa{sv}} properties:

New connection settings, properties, and (optionally) secrets.

+
+
+
+

The UpdateUnsaved() method

+
+UpdateUnsaved (IN  a{sa{sv}} properties);
+
+

Update the connection with new settings and properties (replacing all previous settings and properties) but do not immediately save the connection to disk. Secrets may be part of the update request and may sent to a Secret Agent for storage, depending on the flags associated with each secret. Use the 'Save' method to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).

+
++++ + + + + +

IN a{sa{sv}} properties:

New connection settings, properties, and (optionally) secrets.

+
+
+
+

The Delete() method

+
+Delete ();
+
+

Delete the connection.

+
+
+
+

The GetSettings() method

+
+GetSettings (OUT a{sa{sv}} settings);
+
+

Get the settings maps describing this network configuration. This will never include any secrets required for connection to the network, as those are often protected. Secrets must be requested separately using the GetSecrets() call.

+
++++ + + + + +

OUT a{sa{sv}} settings:

The nested settings maps describing this object.

+
+
+
+

The GetSecrets() method

+
+GetSecrets (IN  s         setting_name,
+            OUT a{sa{sv}} secrets);
+
+

Get the secrets belonging to this network configuration. Only secrets from persistent storage or a Secret Agent running in the requestor's session will be returned. The user will never be prompted for secrets as a result of this request.

+
++++ + + + + + + + + + + +

IN s setting_name:

Name of the setting to return secrets for. If empty, all all secrets will be returned.

OUT a{sa{sv}} secrets:

Nested settings maps containing secrets.

+
+
+
+

The ClearSecrets() method

+
+ClearSecrets ();
+
+

Clear the secrets belonging to this network connection profile.

+
+
+
+

The Save() method

+
+Save ();
+
+

Saves a "dirty" connection (that had previously been updated with UpdateUnsaved) to persistent storage.

+
+
+
+

Signal Details

+
+

The "Updated" signal

+
+Updated ();
+
+

Emitted when any settings or permissions change. When handling this signal, clients should re-read the connection using the GetSettings method to get the changes and to ensure the client still has permission to access the connection.

+
+
+
+

The "Removed" signal

+
+Removed ();
+
+

Emitted when this connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the object no longer exists. Also see the Settings.ConnectionRemoved signal.

+
+
+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values.

+
+
+
+

Property Details

+
+

The "Unsaved" property

+
+Unsaved  readable   b
+
+

If set, indicates that the in-memory state of the connection does not match the on-disk state. This flag will be set when UpdateUnsaved() is called or when any connection details change, and cleared when the connection is saved to disk via Save() or from internal operations.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html new file mode 100644 index 00000000..d4b243dc --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html @@ -0,0 +1,320 @@ + + + + +org.freedesktop.NetworkManager.Settings: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.Settings

+

org.freedesktop.NetworkManager.Settings

+
+
+

Methods

+
+ListConnections      (OUT ao        connections);
+GetConnectionByUuid  (IN  s         uuid,
+                      OUT o         connection);
+AddConnection        (IN  a{sa{sv}} connection,
+                      OUT o         path);
+AddConnectionUnsaved (IN  a{sa{sv}} connection,
+                      OUT o         path);
+LoadConnections      (IN  as        filenames,
+                      OUT b         status,
+                      OUT as        failures);
+ReloadConnections    (OUT b         status);
+SaveHostname         (IN  s         hostname);
+
+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+NewConnection     (o     connection);
+ConnectionRemoved (o     connection);
+
+
+
+

Properties

+
+Connections  readable   ao
+Hostname     readable   s
+CanModify    readable   b
+
+
+
+

Description

+

The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.

+
+
+

Method Details

+
+

The ListConnections() method

+
+ListConnections (OUT ao connections);
+
+

List the saved network connections known to NetworkManager.

+
++++ + + + + +

OUT ao connections:

List of connections.

+
+
+
+

The GetConnectionByUuid() method

+
+GetConnectionByUuid (IN  s uuid,
+                     OUT o connection);
+
+

Retrieve the object path of a connection, given that connection's UUID.

+
++++ + + + + + + + + + + +

IN s uuid:

The UUID to find the connection object path for.

OUT o connection:

The connection's object path.

+
+
+
+

The AddConnection() method

+
+AddConnection (IN  a{sa{sv}} connection,
+               OUT o         path);
+
+

Add new connection and save it to disk. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically.

+
++++ + + + + + + + + + + +

IN a{sa{sv}} connection:

Connection settings and properties.

OUT o path:

Object path of the new connection that was just added.

+
+
+
+

The AddConnectionUnsaved() method

+
+AddConnectionUnsaved (IN  a{sa{sv}} connection,
+                      OUT o         path);
+
+

Add new connection but do not save it to disk immediately. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically. Use the 'Save' method on the connection to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).

+
++++ + + + + + + + + + + +

IN a{sa{sv}} connection:

Connection settings and properties.

OUT o path:

Object path of the new connection that was just added.

+
+
+
+

The LoadConnections() method

+
+LoadConnections (IN  as filenames,
+                 OUT b  status,
+                 OUT as failures);
+
+

Loads or reloads the indicated connections from disk. You should call this after making changes directly to an on-disk connection file to make sure that NetworkManager sees the changes. (If "monitor-connection-files" in NetworkManager.conf is "true", then this will have no real effect, but is harmless.) As with AddConnection(), this operation does not necessarily start the network connection.

+
++++ + + + + + + + + + + + + + + +

IN as filenames:

Array of paths to on-disk connection profiles in directories monitored by NetworkManager.

OUT b status:

Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).

OUT as failures:

Paths of connection files that could not be loaded.

+
+
+
+

The ReloadConnections() method

+
+ReloadConnections (OUT b status);
+
+

Tells NetworkManager to reload all connection files from disk, including noticing any added or deleted connection files. By default, connections are re-read automatically any time they change, so you only need to use this command if you have set "monitor-connection-files=false" in NetworkManager.conf.

+
++++ + + + + +

OUT b status:

Success or failure.

+
+
+
+

The SaveHostname() method

+
+SaveHostname (IN  s hostname);
+
+

Save the hostname to persistent configuration.

+
++++ + + + + +

IN s hostname:

The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.

+
+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

The "NewConnection" signal

+
+NewConnection (o connection);
+
+

Emitted when a new connection has been added after NetworkManager has started up and initialized. This signal is not emitted for connections read while starting up, because NetworkManager's D-Bus service is only available after all connections have been read, and to prevent spamming listeners with too many signals at one time. To retrieve the initial connection list, call the ListConnections() method once, and then listen for individual Settings.NewConnection and Settings.Connection.Deleted signals for further updates.

+
++++ + + + + +

o connection:

Object path of the new connection.

+
+
+
+

The "ConnectionRemoved" signal

+
+ConnectionRemoved (o connection);
+
+

Emitted when a connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the connection no longer exists and cannot be used. Also see the Settings.Connection.Removed signal.

+
++++ + + + + +

o connection:

Object path of the removed connection.

+
+
+
+

Property Details

+
+

The "Connections" property

+
+Connections  readable   ao
+
+

List of object paths of available network connection profiles.

+
+
+
+

The "Hostname" property

+
+Hostname  readable   s
+
+

The machine hostname stored in persistent configuration.

+
+
+
+

The "CanModify" property

+
+CanModify  readable   b
+
+

If true, adding and modifying connections is supported.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html new file mode 100644 index 00000000..ea6bd031 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html @@ -0,0 +1,122 @@ + + + + +org.freedesktop.NetworkManager.VPN.Connection: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.VPN.Connection

+

org.freedesktop.NetworkManager.VPN.Connection

+
+
+

Signals

+
+PropertiesChanged (a{sv} properties);
+VpnStateChanged   (u     state,
+                   u     reason);
+
+
+
+

Properties

+
+VpnState  readable   u
+Banner    readable   s
+
+
+
+

Description

+

Represents an active connection to a Virtual Private Network.

+
+
+

Signal Details

+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

+
++++ + + + + +

a{sv} properties:

A dictionary mapping property names to variant boxed values

+
+
+
+

The "VpnStateChanged" signal

+
+VpnStateChanged (u state,
+                 u reason);
+
+

Emitted when the state of the VPN connection has changed.

+
++++ + + + + + + + + + + +

u state:

The new state of the VPN connection.

u reason:

Reason code describing the change to the new state.

+
+
+
+

Property Details

+
+

The "VpnState" property

+
+VpnState  readable   u
+
+

The VPN-specific state of the connection.

+
+
+
+

The "Banner" property

+
+Banner  readable   s
+
+

The banner string of the VPN connection.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html new file mode 100644 index 00000000..64517b2c --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html @@ -0,0 +1,392 @@ + + + + +org.freedesktop.NetworkManager.VPN.Plugin: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager.VPN.Plugin

+

org.freedesktop.NetworkManager.VPN.Plugin

+
+
+

Methods

+
+Connect            (IN  a{sa{sv}} connection);
+ConnectInteractive (IN  a{sa{sv}} connection,
+                    IN  a{sv}     details);
+NeedSecrets        (IN  a{sa{sv}} settings,
+                    OUT s         setting_name);
+Disconnect         ();
+SetConfig          (IN  a{sv}     config);
+SetIp4Config       (IN  a{sv}     config);
+SetIp6Config       (IN  a{sv}     config);
+SetFailure         (IN  s         reason);
+NewSecrets         (IN  a{sa{sv}} connection);
+
+
+
+

Signals

+
+StateChanged    (u     state);
+SecretsRequired (s     message,
+                 as    secrets);
+Config          (a{sv} config);
+Ip4Config       (a{sv} ip4config);
+Ip6Config       (a{sv} ip6config);
+LoginBanner     (s     banner);
+Failure         (u     reason);
+
+
+
+

Properties

+
+State  readable   u
+
+
+
+

Description

+

This interface is provided by plugins providing VPN services to the NetworkManager daemon.

+
+
+

Method Details

+
+

The Connect() method

+
+Connect (IN  a{sa{sv}} connection);
+
+

Tells the plugin to connect. Interactive secrets requests (eg, emitting the SecretsRequired signal) are not allowed.

+
++++ + + + + +

IN a{sa{sv}} connection:

Describes the connection to be established.

+
+
+
+

The ConnectInteractive() method

+
+ConnectInteractive (IN  a{sa{sv}} connection,
+                    IN  a{sv}     details);
+
+

Tells the plugin to connect, allowing interactive secrets requests (eg the plugin is allowed to emit the SecretsRequired signal if the VPN service indicates that it needs additional secrets during the connect process).

+
++++ + + + + + + + + + + +

IN a{sa{sv}} connection:

Describes the connection to be established.

IN a{sv} details:

Additional details about the Connect process.

+
+
+
+

The NeedSecrets() method

+
+NeedSecrets (IN  a{sa{sv}} settings,
+             OUT s         setting_name);
+
+

Asks the plugin whether the provided connection will require secrets to connect successfully.

+
++++ + + + + + + + + + + +

IN a{sa{sv}} settings:

Describes the connection that may need secrets.

OUT s setting_name:

The setting name within the provided connection that requires secrets, if any.

+
+
+
+

The Disconnect() method

+
+Disconnect ();
+
+

Disconnect the plugin.

+
+
+
+

The SetConfig() method

+
+SetConfig (IN  a{sv} config);
+
+

Set generic connection details on the connection.

+
++++ + + + + +

IN a{sv} config:

Generic configuration details for the connection.

+
+
+
+

The SetIp4Config() method

+
+SetIp4Config (IN  a{sv} config);
+
+

Set IPv4 details on the connection.

+
++++ + + + + +

IN a{sv} config:

Ip4Config details for the connection. You must call SetConfig() before calling this.

+
+
+
+

The SetIp6Config() method

+
+SetIp6Config (IN  a{sv} config);
+
+

Set IPv6 details on the connection.

+
++++ + + + + +

IN a{sv} config:

Ip6Config details for the connection. You must call SetConfig() before calling this.

+
+
+
+

The SetFailure() method

+
+SetFailure (IN  s reason);
+
+

Indicate a failure to the plugin.

+
++++ + + + + +

IN s reason:

The reason for the failure.

+
+
+
+

The NewSecrets() method

+
+NewSecrets (IN  a{sa{sv}} connection);
+
+

Called in response to a SecretsRequired signal to deliver updated secrets or other information to the plugin.

+
++++ + + + + +

IN a{sa{sv}} connection:

Describes the connection including the new secrets.

+
+
+
+

Signal Details

+
+

The "StateChanged" signal

+
+StateChanged (u state);
+
+

Emitted when the plugin state changes.

+
++++ + + + + +

u state:

The new state of the plugin.

+
+
+
+

The "SecretsRequired" signal

+
+SecretsRequired (s  message,
+                 as secrets);
+
+

Emitted during an ongoing ConnectInteractive() request when the plugin has determined that new secrets are required. NetworkManager will then call the NewSecrets() method with a connection hash including the new secrets.

+
++++ + + + + + + + + + + +

s message:

Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.

as secrets:

Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.

+
+
+
+

The "Config" signal

+
+Config (a{sv} config);
+
+

The plugin obtained generic configuration information.

+
++++ + + + + +

a{sv} config:

The configuration information.

+
+
+
+

The "Ip4Config" signal

+
+Ip4Config (a{sv} ip4config);
+
+

The plugin obtained an IPv4 configuration.

+
++++ + + + + +

a{sv} ip4config:

The IPv4 configuration.

+
+
+
+

The "Ip6Config" signal

+
+Ip6Config (a{sv} ip6config);
+
+

The plugin obtained an IPv6 configuration.

+
++++ + + + + +

a{sv} ip6config:

The IPv6 configuration.

+
+
+
+

The "LoginBanner" signal

+
+LoginBanner (s banner);
+
+

Emitted when the plugin receives a login banner from the VPN service.

+
++++ + + + + +

s banner:

The login banner string.

+
+
+
+

The "Failure" signal

+
+Failure (u reason);
+
+

Emitted when a failure in the VPN plugin occurs.

+
++++ + + + + +

u reason:

Reason code for the failure.

+
+
+
+

Property Details

+
+

The "State" property

+
+State  readable   u
+
+

The state of the plugin.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html new file mode 100644 index 00000000..ec168881 --- /dev/null +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html @@ -0,0 +1,638 @@ + + + + +org.freedesktop.NetworkManager: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

org.freedesktop.NetworkManager

+

org.freedesktop.NetworkManager

+
+
+

Methods

+
+GetDevices               (OUT ao        devices);
+GetAllDevices            (OUT ao        devices);
+GetDeviceByIpIface       (IN  s         iface,
+                          OUT o         device);
+ActivateConnection       (IN  o         connection,
+                          IN  o         device,
+                          IN  o         specific_object,
+                          OUT o         active_connection);
+AddAndActivateConnection (IN  a{sa{sv}} connection,
+                          IN  o         device,
+                          IN  o         specific_object,
+                          OUT o         path,
+                          OUT o         active_connection);
+DeactivateConnection     (IN  o         active_connection);
+Sleep                    (IN  b         sleep);
+Enable                   (IN  b         enable);
+GetPermissions           (OUT a{ss}     permissions);
+SetLogging               (IN  s         level,
+                          IN  s         domains);
+GetLogging               (OUT s         level,
+                          OUT s         domains);
+CheckConnectivity        (OUT u         connectivity);
+state                    (OUT u         state);
+
+
+
+

Signals

+
+CheckPermissions  ();
+StateChanged      (u     state);
+PropertiesChanged (a{sv} properties);
+DeviceAdded       (o     device_path);
+DeviceRemoved     (o     device_path);
+
+
+
+

Properties

+
+Devices                  readable   ao
+AllDevices               readable   ao
+NetworkingEnabled        readable   b
+WirelessEnabled          readwrite  b
+WirelessHardwareEnabled  readable   b
+WwanEnabled              readwrite  b
+WwanHardwareEnabled      readable   b
+WimaxEnabled             readwrite  b
+WimaxHardwareEnabled     readable   b
+ActiveConnections        readable   ao
+PrimaryConnection        readable   o
+PrimaryConnectionType    readable   s
+Metered                  readable   u
+ActivatingConnection     readable   o
+Startup                  readable   b
+Version                  readable   s
+State                    readable   u
+Connectivity             readable   u
+GlobalDnsConfiguration   readwrite  a{sv}
+
+
+
+

Description

+

+
+
+

Method Details

+
+

The GetDevices() method

+
+GetDevices (OUT ao devices);
+
+

Get the list of realized network devices.

+
++++ + + + + +

OUT ao devices:

List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).

+
+
+
+

The GetAllDevices() method

+
+GetAllDevices (OUT ao devices);
+
+

Get the list of all network devices.

+
++++ + + + + +

OUT ao devices:

List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated).

+
+
+
+

The GetDeviceByIpIface() method

+
+GetDeviceByIpIface (IN  s iface,
+                    OUT o device);
+
+

Return the object path of the network device referenced by its IP interface name. Note that some devices (usually modems) only have an IP interface name when they are connected.

+
++++ + + + + + + + + + + +

IN s iface:

Interface name of the device to find.

OUT o device:

Object path of the network device.

+
+
+
+

The ActivateConnection() method

+
+ActivateConnection (IN  o connection,
+                    IN  o device,
+                    IN  o specific_object,
+                    OUT o active_connection);
+
+

Activate a connection using the supplied device.

+
++++ + + + + + + + + + + + + + + + + + + +

IN o connection:

The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.

IN o device:

The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.

OUT o active_connection:

The path of the active connection object representing this active connection.

+
+
+
+

The AddAndActivateConnection() method

+
+AddAndActivateConnection (IN  a{sa{sv}} connection,
+                          IN  o         device,
+                          IN  o         specific_object,
+                          OUT o         path,
+                          OUT o         active_connection);
+
+

Adds a new connection using the given details (if any) as a template (automatically filling in missing settings with the capabilities of the given device and specific object), then activate the new connection. Cannot be used for VPN connections at this time.

+
++++ + + + + + + + + + + + + + + + + + + + + + + +

IN a{sa{sv}} connection:

Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.

IN o device:

The object path of device to be activated using the given connection.

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.

OUT o path:

Object path of the new connection that was just added.

OUT o active_connection:

The path of the active connection object representing this active connection.

+
+
+
+

The DeactivateConnection() method

+
+DeactivateConnection (IN  o active_connection);
+
+

Deactivate an active connection.

+
++++ + + + + +

IN o active_connection:

The currently active connection to deactivate.

+
+
+
+

The Sleep() method

+
+Sleep (IN  b sleep);
+
+

Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated. When awake, devices are available to be activated. This command should not be called directly by users or clients; it is intended for system suspend/resume tracking.

+
++++ + + + + +

IN b sleep:

Indicates whether the NetworkManager daemon should sleep or wake.

+
+
+
+

The Enable() method

+
+Enable (IN  b enable);
+
+

Control whether overall networking is enabled or disabled. When disabled, all interfaces that NM manages are deactivated. When enabled, all managed interfaces are re-enabled and available to be activated. This command should be used by clients that provide to users the ability to enable/disable all networking.

+
++++ + + + + +

IN b enable:

If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.

+
+
+
+

The GetPermissions() method

+
+GetPermissions (OUT a{ss} permissions);
+
+

Returns the permissions a caller has for various authenticated operations that NetworkManager provides, like Enable/Disable networking, changing WiFi, WWAN, and WiMAX state, etc.

+
++++ + + + + +

OUT a{ss} permissions:

Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.

+
+
+
+

The SetLogging() method

+
+SetLogging (IN  s level,
+            IN  s domains);
+
+

Set logging verbosity and which operations are logged.

+
++++ + + + + + + + + + + +

IN s level:

One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.

IN s domains:

A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.

+
+
+
+

The GetLogging() method

+
+GetLogging (OUT s level,
+            OUT s domains);
+
+

Get current logging verbosity level and operations domains.

+
++++ + + + + + + + + + + +

OUT s level:

One of [ERR, WARN, INFO, DEBUG, TRACE].

OUT s domains:

For available domains see SetLogging() call.

+
+
+
+

The CheckConnectivity() method

+
+CheckConnectivity (OUT u connectivity);
+
+

Re-check the network connectivity state.

+
++++ + + + + +

OUT u connectivity:

The current connectivity state.

+
+
+
+

The state() method

+
+state (OUT u state);
+
+

The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under it's management.

+
++++ + + + + +

OUT u state:

+
+
+
+

Signal Details

+
+

The "CheckPermissions" signal

+
+CheckPermissions ();
+
+

Emitted when system authorization details change, indicating that clients may wish to recheck permissions with GetPermissions.

+
+
+
+

The "StateChanged" signal

+
+StateChanged (u state);
+
+

NetworkManager's state changed.

+
++++ + + + + +

u state:

The new state of NetworkManager.

+
+
+
+

The "PropertiesChanged" signal

+
+PropertiesChanged (a{sv} properties);
+
+

NetworkManager's properties changed.

+
++++ + + + + +

a{sv} properties:

The changed properties.

+
+
+
+

The "DeviceAdded" signal

+
+DeviceAdded (o device_path);
+
+

A device was added to the system

+
++++ + + + + +

o device_path:

The object path of the newly added device.

+
+
+
+

The "DeviceRemoved" signal

+
+DeviceRemoved (o device_path);
+
+

A device was removed from the system, and is no longer available.

+
++++ + + + + +

o device_path:

The object path of the device that was just removed.

+
+
+
+

Property Details

+
+

The "Devices" property

+
+Devices  readable   ao
+
+

The list of realized network devices. Realized devices are those which have backing resources (eg from the kernel or a management daemon like ModemManager, teamd, etc).

+
+
+
+

The "AllDevices" property

+
+AllDevices  readable   ao
+
+

The list of both realized and un-realized network devices. Un-realized devices are software devices which do not yet have backing resources, but for which backing resources can be created if the device is activated.

+
+
+
+

The "NetworkingEnabled" property

+
+NetworkingEnabled  readable   b
+
+

Indicates if overall networking is currently enabled or not. See the Enable() method.

+
+
+
+

The "WirelessEnabled" property

+
+WirelessEnabled  readwrite  b
+
+

Indicates if wireless is currently enabled or not.

+
+
+
+

The "WirelessHardwareEnabled" property

+
+WirelessHardwareEnabled  readable   b
+
+

Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.

+
+
+
+

The "WwanEnabled" property

+
+WwanEnabled  readwrite  b
+
+

Indicates if mobile broadband devices are currently enabled or not.

+
+
+
+

The "WwanHardwareEnabled" property

+
+WwanHardwareEnabled  readable   b
+
+

Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.

+
+
+
+

The "WimaxEnabled" property

+
+WimaxEnabled  readwrite  b
+
+

Indicates if WiMAX devices are currently enabled or not.

+
+
+
+

The "WimaxHardwareEnabled" property

+
+WimaxHardwareEnabled  readable   b
+
+

Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.

+
+
+
+

The "ActiveConnections" property

+
+ActiveConnections  readable   ao
+
+

List of active connection object paths.

+
+
+
+

The "PrimaryConnection" property

+
+PrimaryConnection  readable   o
+
+

The object path of the "primary" active connection being used to access the network. In particular, if there is no VPN active, or the VPN does not have the default route, then this indicates the connection that has the default route. If there is a VPN active with the default route, then this indicates the connection that contains the route to the VPN endpoint.

+
+
+
+

The "PrimaryConnectionType" property

+
+PrimaryConnectionType  readable   s
+
+

The connection type of the "primary" active connection being used to access the network. This is the same as the Type property on the object indicated by PrimaryConnection.

+
+
+
+

The "Metered" property

+
+Metered  readable   u
+
+

Indicates whether the connectivity is metered. This is equivalent to the metered property of the device associated with the primary connection.

+
+
+
+

The "ActivatingConnection" property

+
+ActivatingConnection  readable   o
+
+

The object path of an active connection that is currently being activated and which is expected to become the new PrimaryConnection when it finishes activating.

+
+
+
+

The "Startup" property

+
+Startup  readable   b
+
+

Indicates whether NM is still starting up; this becomes FALSE when NM has finished attempting to activate every connection that it might be able to activate at startup.

+
+
+
+

The "Version" property

+
+Version  readable   s
+
+

NetworkManager version.

+
+
+
+

The "State" property

+
+State  readable   u
+
+

The overall state of the NetworkManager daemon.

+
+
+
+

The "Connectivity" property

+
+Connectivity  readable   u
+
+

The network connectivity state.

+
+
+
+

The "GlobalDnsConfiguration" property

+
+GlobalDnsConfiguration  readwrite  a{sv}
+
+

Dictionary of global DNS settings where the key is one of "searches", "options" and "domains". The values for the "searches" and "options" keys are string arrays describing the list of search domains and resolver options, respectively. The value of the "domains" key is a second-level dictionary, where each key is a domain name, and each key's value is a third-level dictionary with the keys "servers" and "options". "servers" is a string array of DNS servers, "options" is a string array of domain-specific options.

+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 054d41e2..dccef7c9 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -2,10 +2,10 @@ -NetworkManager D-Bus Reference Manual: NetworkManager D-Bus Reference Manual +NetworkManager D-Bus API Reference Manual: NetworkManager D-Bus API Reference Manual - - + + @@ -13,10 +13,10 @@
-
-

Version 1.1.91 +

+

Version 1.1.92

-

Copyright © 2012 The NetworkManager Authors

+

Copyright © 2012, 2016 The NetworkManager Authors

Permission is granted to copy, distribute and/or modify this @@ -43,29 +43,136 @@

-
D-Bus API Reference
+
D-Bus API Reference
+
+
Interfaces
+
+
+org.freedesktop.NetworkManager +
+
+org.freedesktop.NetworkManager.Settings +
+
+org.freedesktop.NetworkManager.AgentManager +
+
+org.freedesktop.NetworkManager.AccessPoint +
+
+org.freedesktop.NetworkManager.PPP +
+
+org.freedesktop.NetworkManager.Settings.Connection +
+
+org.freedesktop.NetworkManager.VPN.Connection +
+
+org.freedesktop.NetworkManager.Connection.Active +
+
+org.freedesktop.NetworkManager.Device +
+
+org.freedesktop.NetworkManager.Device.Adsl +
+
+org.freedesktop.NetworkManager.Device.Bond +
+
+org.freedesktop.NetworkManager.Device.Bridge +
+
+org.freedesktop.NetworkManager.Device.Bluetooth +
+
+org.freedesktop.NetworkManager.Device.Wired +
+
+org.freedesktop.NetworkManager.Device.Generic +
+
+org.freedesktop.NetworkManager.Device.Infiniband +
+
+org.freedesktop.NetworkManager.Device.IPTunnel +
+
+org.freedesktop.NetworkManager.Device.Macvlan +
+
+org.freedesktop.NetworkManager.Device.Modem +
+
+org.freedesktop.NetworkManager.Device.OlpcMesh +
+
+org.freedesktop.NetworkManager.Device.Team +
+
+org.freedesktop.NetworkManager.Device.Tun +
+
+org.freedesktop.NetworkManager.Device.Veth +
+
+org.freedesktop.NetworkManager.Device.Vlan +
+
+org.freedesktop.NetworkManager.Device.Vxlan +
+
+org.freedesktop.NetworkManager.Device.Wireless +
+
+org.freedesktop.NetworkManager.Device.WiMax +
+
+org.freedesktop.NetworkManager.DHCP4Config +
+
+org.freedesktop.NetworkManager.DHCP6Config +
+
+org.freedesktop.NetworkManager.IP4Config +
+
+org.freedesktop.NetworkManager.IP6Config +
+
+org.freedesktop.NetworkManager.VPN.Plugin +
+
+org.freedesktop.NetworkManager.SecretAgent +
+
+
Network Configuration Setting Specification
Configuration Settings
Secret flag types
-
Migrating from NetworkManager 0.8 to NetworkManager 0.9
-
-
Architecture and D-Bus API Changes in 0.9
+
UNIX Manual Pages
-
Elimination of the User Settings Service
-
User Secret Agents
-
Settings Service Interface Changes
-
Connection Object Interface Changes
-
Permissions Methods Consolidation
-
AddConnection Returns Object Path of New Connection
-
Support for WiMAX Devices
-
New Device States
-
New Active Connection State
-
Consolidated Modem Devices
-
Secret Property Flags
-
Deprecated Methods Removed
-
+
+NetworkManager — network management daemon +
+
+NetworkManager.conf — NetworkManager configuration file +
+
+nmcli-examples — usage examples of nmcli +
+
+nm-settings — Description of settings and properties of NetworkManager connection profiles +
+
+nm-settings-keyfile — Description of keyfile settings plugin +
+
+nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin +
Index
A. License
diff --git a/docs/api/html/index.sgml b/docs/api/html/index.sgml new file mode 100644 index 00000000..dc84d959 --- /dev/null +++ b/docs/api/html/index.sgml @@ -0,0 +1,434 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index 54a8424f..f8e1c9d6 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -2,11 +2,11 @@ -Index: NetworkManager D-Bus Reference Manual +Index: NetworkManager D-Bus API Reference Manual - - - + + + @@ -16,13 +16,686 @@ Home -Prev +Prev Next

Index

-
+
+
+

Symbols

+
+
org.freedesktop.NetworkManager.AccessPoint, org.freedesktop.NetworkManager.AccessPoint +
+
org.freedesktop.NetworkManager.AccessPoint::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.AccessPoint:Flags, The "Flags" property +
+
org.freedesktop.NetworkManager.AccessPoint:Frequency, The "Frequency" property +
+
org.freedesktop.NetworkManager.AccessPoint:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.AccessPoint:LastSeen, The "LastSeen" property +
+
org.freedesktop.NetworkManager.AccessPoint:MaxBitrate, The "MaxBitrate" property +
+
org.freedesktop.NetworkManager.AccessPoint:Mode, The "Mode" property +
+
org.freedesktop.NetworkManager.AccessPoint:RsnFlags, The "RsnFlags" property +
+
org.freedesktop.NetworkManager.AccessPoint:Ssid, The "Ssid" property +
+
org.freedesktop.NetworkManager.AccessPoint:Strength, The "Strength" property +
+
org.freedesktop.NetworkManager.AccessPoint:WpaFlags, The "WpaFlags" property +
+
org.freedesktop.NetworkManager.AgentManager, org.freedesktop.NetworkManager.AgentManager +
+
org.freedesktop.NetworkManager.AgentManager.Register(), The Register() method +
+
org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities(), The RegisterWithCapabilities() method +
+
org.freedesktop.NetworkManager.AgentManager.Unregister(), The Unregister() method +
+
org.freedesktop.NetworkManager.Device, org.freedesktop.NetworkManager.Device +
+
org.freedesktop.NetworkManager.Device.Adsl, org.freedesktop.NetworkManager.Device.Adsl +
+
org.freedesktop.NetworkManager.Device.Adsl::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Adsl:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Bluetooth, org.freedesktop.NetworkManager.Device.Bluetooth +
+
org.freedesktop.NetworkManager.Device.Bluetooth::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Bluetooth:BtCapabilities, The "BtCapabilities" property +
+
org.freedesktop.NetworkManager.Device.Bluetooth:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Bluetooth:Name, The "Name" property +
+
org.freedesktop.NetworkManager.Device.Bond, org.freedesktop.NetworkManager.Device.Bond +
+
org.freedesktop.NetworkManager.Device.Bond::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Bond:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Bond:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Bond:Slaves, The "Slaves" property +
+
org.freedesktop.NetworkManager.Device.Bridge, org.freedesktop.NetworkManager.Device.Bridge +
+
org.freedesktop.NetworkManager.Device.Bridge::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Bridge:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Bridge:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Bridge:Slaves, The "Slaves" property +
+
org.freedesktop.NetworkManager.Device.Delete(), The Delete() method +
+
org.freedesktop.NetworkManager.Device.Disconnect(), The Disconnect() method +
+
org.freedesktop.NetworkManager.Device.Generic, org.freedesktop.NetworkManager.Device.Generic +
+
org.freedesktop.NetworkManager.Device.Generic::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Generic:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Generic:TypeDescription, The "TypeDescription" property +
+
org.freedesktop.NetworkManager.Device.GetAppliedConnection(), The GetAppliedConnection() method +
+
org.freedesktop.NetworkManager.Device.Infiniband, org.freedesktop.NetworkManager.Device.Infiniband +
+
org.freedesktop.NetworkManager.Device.Infiniband::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Infiniband:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Infiniband:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel, org.freedesktop.NetworkManager.Device.IPTunnel +
+
org.freedesktop.NetworkManager.Device.IPTunnel::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.IPTunnel:EncapsulationLimit, The "EncapsulationLimit" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:FlowLabel, The "FlowLabel" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:InputKey, The "InputKey" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Local, The "Local" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Mode, The "Mode" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:OutputKey, The "OutputKey" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Parent, The "Parent" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:PathMtuDiscovery, The "PathMtuDiscovery" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Remote, The "Remote" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Tos, The "Tos" property +
+
org.freedesktop.NetworkManager.Device.IPTunnel:Ttl, The "Ttl" property +
+
org.freedesktop.NetworkManager.Device.Macvlan, org.freedesktop.NetworkManager.Device.Macvlan +
+
org.freedesktop.NetworkManager.Device.Macvlan::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Macvlan:Mode, The "Mode" property +
+
org.freedesktop.NetworkManager.Device.Macvlan:NoPromisc, The "NoPromisc" property +
+
org.freedesktop.NetworkManager.Device.Macvlan:Parent, The "Parent" property +
+
org.freedesktop.NetworkManager.Device.Macvlan:Tap, The "Tap" property +
+
org.freedesktop.NetworkManager.Device.Modem, org.freedesktop.NetworkManager.Device.Modem +
+
org.freedesktop.NetworkManager.Device.Modem::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Modem:CurrentCapabilities, The "CurrentCapabilities" property +
+
org.freedesktop.NetworkManager.Device.Modem:ModemCapabilities, The "ModemCapabilities" property +
+
org.freedesktop.NetworkManager.Device.OlpcMesh, org.freedesktop.NetworkManager.Device.OlpcMesh +
+
org.freedesktop.NetworkManager.Device.OlpcMesh::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.OlpcMesh:ActiveChannel, The "ActiveChannel" property +
+
org.freedesktop.NetworkManager.Device.OlpcMesh:Companion, The "Companion" property +
+
org.freedesktop.NetworkManager.Device.OlpcMesh:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Reapply(), The Reapply() method +
+
org.freedesktop.NetworkManager.Device.Team, org.freedesktop.NetworkManager.Device.Team +
+
org.freedesktop.NetworkManager.Device.Team::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Team:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Team:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Team:Slaves, The "Slaves" property +
+
org.freedesktop.NetworkManager.Device.Tun, org.freedesktop.NetworkManager.Device.Tun +
+
org.freedesktop.NetworkManager.Device.Tun::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Tun:Group, The "Group" property +
+
org.freedesktop.NetworkManager.Device.Tun:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Tun:Mode, The "Mode" property +
+
org.freedesktop.NetworkManager.Device.Tun:MultiQueue, The "MultiQueue" property +
+
org.freedesktop.NetworkManager.Device.Tun:NoPi, The "NoPi" property +
+
org.freedesktop.NetworkManager.Device.Tun:Owner, The "Owner" property +
+
org.freedesktop.NetworkManager.Device.Tun:VnetHdr, The "VnetHdr" property +
+
org.freedesktop.NetworkManager.Device.Veth, org.freedesktop.NetworkManager.Device.Veth +
+
org.freedesktop.NetworkManager.Device.Veth::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Veth:Peer, The "Peer" property +
+
org.freedesktop.NetworkManager.Device.Vlan, org.freedesktop.NetworkManager.Device.Vlan +
+
org.freedesktop.NetworkManager.Device.Vlan::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Vlan:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Vlan:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Vlan:Parent, The "Parent" property +
+
org.freedesktop.NetworkManager.Device.Vlan:VlanId, The "VlanId" property +
+
org.freedesktop.NetworkManager.Device.Vxlan, org.freedesktop.NetworkManager.Device.Vxlan +
+
org.freedesktop.NetworkManager.Device.Vxlan::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Vxlan:Ageing, The "Ageing" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:DstPort, The "DstPort" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Group, The "Group" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Id, The "Id" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:L2miss, The "L2miss" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:L3miss, The "L3miss" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Learning, The "Learning" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Limit, The "Limit" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Local, The "Local" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Parent, The "Parent" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Proxy, The "Proxy" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Rsc, The "Rsc" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:SrcPortMax, The "SrcPortMax" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:SrcPortMin, The "SrcPortMin" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Tos, The "Tos" property +
+
org.freedesktop.NetworkManager.Device.Vxlan:Ttl, The "Ttl" property +
+
org.freedesktop.NetworkManager.Device.WiMax, org.freedesktop.NetworkManager.Device.WiMax +
+
org.freedesktop.NetworkManager.Device.WiMax.GetNspList(), The GetNspList() method +
+
org.freedesktop.NetworkManager.Device.WiMax::NspAdded, The "NspAdded" signal +
+
org.freedesktop.NetworkManager.Device.WiMax::NspRemoved, The "NspRemoved" signal +
+
org.freedesktop.NetworkManager.Device.WiMax::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.WiMax:ActiveNsp, The "ActiveNsp" property +
+
org.freedesktop.NetworkManager.Device.WiMax:Bsid, The "Bsid" property +
+
org.freedesktop.NetworkManager.Device.WiMax:CenterFrequency, The "CenterFrequency" property +
+
org.freedesktop.NetworkManager.Device.WiMax:Cinr, The "Cinr" property +
+
org.freedesktop.NetworkManager.Device.WiMax:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.WiMax:Nsps, The "Nsps" property +
+
org.freedesktop.NetworkManager.Device.WiMax:Rssi, The "Rssi" property +
+
org.freedesktop.NetworkManager.Device.WiMax:TxPower, The "TxPower" property +
+
org.freedesktop.NetworkManager.Device::StateChanged, The "StateChanged" signal +
+
org.freedesktop.NetworkManager.Device:ActiveConnection, The "ActiveConnection" property +
+
org.freedesktop.NetworkManager.Device:Autoconnect, The "Autoconnect" property +
+
org.freedesktop.NetworkManager.Device:AvailableConnections, The "AvailableConnections" property +
+
org.freedesktop.NetworkManager.Device:Capabilities, The "Capabilities" property +
+
org.freedesktop.NetworkManager.Device:DeviceType, The "DeviceType" property +
+
org.freedesktop.NetworkManager.Device:Dhcp4Config, The "Dhcp4Config" property +
+
org.freedesktop.NetworkManager.Device:Dhcp6Config, The "Dhcp6Config" property +
+
org.freedesktop.NetworkManager.Device:Driver, The "Driver" property +
+
org.freedesktop.NetworkManager.Device:DriverVersion, The "DriverVersion" property +
+
org.freedesktop.NetworkManager.Device:FirmwareMissing, The "FirmwareMissing" property +
+
org.freedesktop.NetworkManager.Device:FirmwareVersion, The "FirmwareVersion" property +
+
org.freedesktop.NetworkManager.Device:Interface, The "Interface" property +
+
org.freedesktop.NetworkManager.Device:Ip4Address, The "Ip4Address" property +
+
org.freedesktop.NetworkManager.Device:Ip4Config, The "Ip4Config" property +
+
org.freedesktop.NetworkManager.Device:Ip6Config, The "Ip6Config" property +
+
org.freedesktop.NetworkManager.Device:IpInterface, The "IpInterface" property +
+
org.freedesktop.NetworkManager.Device:LldpNeighbors, The "LldpNeighbors" property +
+
org.freedesktop.NetworkManager.Device:Managed, The "Managed" property +
+
org.freedesktop.NetworkManager.Device:Metered, The "Metered" property +
+
org.freedesktop.NetworkManager.Device:Mtu, The "Mtu" property +
+
org.freedesktop.NetworkManager.Device:NmPluginMissing, The "NmPluginMissing" property +
+
org.freedesktop.NetworkManager.Device:PhysicalPortId, The "PhysicalPortId" property +
+
org.freedesktop.NetworkManager.Device:Real, The "Real" property +
+
org.freedesktop.NetworkManager.Device:State, The "State" property +
+
org.freedesktop.NetworkManager.Device:StateReason, The "StateReason" property +
+
org.freedesktop.NetworkManager.Device:Udi, The "Udi" property +
+
org.freedesktop.NetworkManager.IP4Config, org.freedesktop.NetworkManager.IP4Config +
+
org.freedesktop.NetworkManager.IP4Config::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.IP4Config:AddressData, The "AddressData" property +
+
org.freedesktop.NetworkManager.IP4Config:Addresses, The "Addresses" property +
+
org.freedesktop.NetworkManager.IP4Config:DnsOptions, The "DnsOptions" property +
+
org.freedesktop.NetworkManager.IP4Config:Domains, The "Domains" property +
+
org.freedesktop.NetworkManager.IP4Config:Gateway, The "Gateway" property +
+
org.freedesktop.NetworkManager.IP4Config:Nameservers, The "Nameservers" property +
+
org.freedesktop.NetworkManager.IP4Config:RouteData, The "RouteData" property +
+
org.freedesktop.NetworkManager.IP4Config:Routes, The "Routes" property +
+
org.freedesktop.NetworkManager.IP4Config:Searches, The "Searches" property +
+
org.freedesktop.NetworkManager.IP4Config:WinsServers, The "WinsServers" property +
+
org.freedesktop.NetworkManager.IP6Config, org.freedesktop.NetworkManager.IP6Config +
+
org.freedesktop.NetworkManager.IP6Config::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.IP6Config:AddressData, The "AddressData" property +
+
org.freedesktop.NetworkManager.IP6Config:Addresses, The "Addresses" property +
+
org.freedesktop.NetworkManager.IP6Config:DnsOptions, The "DnsOptions" property +
+
org.freedesktop.NetworkManager.IP6Config:Domains, The "Domains" property +
+
org.freedesktop.NetworkManager.IP6Config:Gateway, The "Gateway" property +
+
org.freedesktop.NetworkManager.IP6Config:Nameservers, The "Nameservers" property +
+
org.freedesktop.NetworkManager.IP6Config:RouteData, The "RouteData" property +
+
org.freedesktop.NetworkManager.IP6Config:Routes, The "Routes" property +
+
org.freedesktop.NetworkManager.IP6Config:Searches, The "Searches" property +
+
org.freedesktop.NetworkManager.SecretAgent, org.freedesktop.NetworkManager.SecretAgent +
+
org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets(), The CancelGetSecrets() method +
+
org.freedesktop.NetworkManager.SecretAgent.DeleteSecrets(), The DeleteSecrets() method +
+
org.freedesktop.NetworkManager.SecretAgent.GetSecrets(), The GetSecrets() method +
+
org.freedesktop.NetworkManager.SecretAgent.SaveSecrets(), The SaveSecrets() method +
+
org.freedesktop.NetworkManager.Settings, org.freedesktop.NetworkManager.Settings +
+
org.freedesktop.NetworkManager.Settings.AddConnection(), The AddConnection() method +
+
org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved(), The AddConnectionUnsaved() method +
+
org.freedesktop.NetworkManager.Settings.Connection, org.freedesktop.NetworkManager.Settings.Connection +
+
org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets(), The ClearSecrets() method +
+
org.freedesktop.NetworkManager.Settings.Connection.Delete(), The Delete() method +
+
org.freedesktop.NetworkManager.Settings.Connection.GetSecrets(), The GetSecrets() method +
+
org.freedesktop.NetworkManager.Settings.Connection.GetSettings(), The GetSettings() method +
+
org.freedesktop.NetworkManager.Settings.Connection.Save(), The Save() method +
+
org.freedesktop.NetworkManager.Settings.Connection.Update(), The Update() method +
+
org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved(), The UpdateUnsaved() method +
+
org.freedesktop.NetworkManager.Settings.Connection::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Settings.Connection::Removed, The "Removed" signal +
+
org.freedesktop.NetworkManager.Settings.Connection::Updated, The "Updated" signal +
+
org.freedesktop.NetworkManager.Settings.Connection:Unsaved, The "Unsaved" property +
+
org.freedesktop.NetworkManager.Settings.GetConnectionByUuid(), The GetConnectionByUuid() method +
+
org.freedesktop.NetworkManager.Settings.ListConnections(), The ListConnections() method +
+
org.freedesktop.NetworkManager.Settings.LoadConnections(), The LoadConnections() method +
+
org.freedesktop.NetworkManager.Settings.ReloadConnections(), The ReloadConnections() method +
+
org.freedesktop.NetworkManager.Settings.SaveHostname(), The SaveHostname() method +
+
org.freedesktop.NetworkManager.Settings::ConnectionRemoved, The "ConnectionRemoved" signal +
+
org.freedesktop.NetworkManager.Settings::NewConnection, The "NewConnection" signal +
+
org.freedesktop.NetworkManager.Settings::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Settings:CanModify, The "CanModify" property +
+
org.freedesktop.NetworkManager.Settings:Connections, The "Connections" property +
+
org.freedesktop.NetworkManager.Settings:Hostname, The "Hostname" property +
+
+
+
+

A

+
+
org.freedesktop.NetworkManager.Connection.Active, org.freedesktop.NetworkManager.Connection.Active +
+
org.freedesktop.NetworkManager.Connection.Active::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Connection.Active:Connection, The "Connection" property +
+
org.freedesktop.NetworkManager.Connection.Active:Default, The "Default" property +
+
org.freedesktop.NetworkManager.Connection.Active:Default6, The "Default6" property +
+
org.freedesktop.NetworkManager.Connection.Active:Devices, The "Devices" property +
+
org.freedesktop.NetworkManager.Connection.Active:Dhcp4Config, The "Dhcp4Config" property +
+
org.freedesktop.NetworkManager.Connection.Active:Dhcp6Config, The "Dhcp6Config" property +
+
org.freedesktop.NetworkManager.Connection.Active:Id, The "Id" property +
+
org.freedesktop.NetworkManager.Connection.Active:Ip4Config, The "Ip4Config" property +
+
org.freedesktop.NetworkManager.Connection.Active:Ip6Config, The "Ip6Config" property +
+
org.freedesktop.NetworkManager.Connection.Active:Master, The "Master" property +
+
org.freedesktop.NetworkManager.Connection.Active:SpecificObject, The "SpecificObject" property +
+
org.freedesktop.NetworkManager.Connection.Active:State, The "State" property +
+
org.freedesktop.NetworkManager.Connection.Active:Type, The "Type" property +
+
org.freedesktop.NetworkManager.Connection.Active:Uuid, The "Uuid" property +
+
org.freedesktop.NetworkManager.Connection.Active:Vpn, The "Vpn" property +
+
+
+
+

D

+
+
org.freedesktop.NetworkManager.Device.Wired, org.freedesktop.NetworkManager.Device.Wired +
+
org.freedesktop.NetworkManager.Device.Wired::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Wired:Carrier, The "Carrier" property +
+
org.freedesktop.NetworkManager.Device.Wired:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Wired:PermHwAddress, The "PermHwAddress" property +
+
org.freedesktop.NetworkManager.Device.Wired:S390Subchannels, The "S390Subchannels" property +
+
org.freedesktop.NetworkManager.Device.Wired:Speed, The "Speed" property +
+
org.freedesktop.NetworkManager.Device.Wireless, org.freedesktop.NetworkManager.Device.Wireless +
+
org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints(), The GetAccessPoints() method +
+
org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints(), The GetAllAccessPoints() method +
+
org.freedesktop.NetworkManager.Device.Wireless.RequestScan(), The RequestScan() method +
+
org.freedesktop.NetworkManager.Device.Wireless::AccessPointAdded, The "AccessPointAdded" signal +
+
org.freedesktop.NetworkManager.Device.Wireless::AccessPointRemoved, The "AccessPointRemoved" signal +
+
org.freedesktop.NetworkManager.Device.Wireless::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.Device.Wireless:AccessPoints, The "AccessPoints" property +
+
org.freedesktop.NetworkManager.Device.Wireless:ActiveAccessPoint, The "ActiveAccessPoint" property +
+
org.freedesktop.NetworkManager.Device.Wireless:Bitrate, The "Bitrate" property +
+
org.freedesktop.NetworkManager.Device.Wireless:HwAddress, The "HwAddress" property +
+
org.freedesktop.NetworkManager.Device.Wireless:Mode, The "Mode" property +
+
org.freedesktop.NetworkManager.Device.Wireless:PermHwAddress, The "PermHwAddress" property +
+
org.freedesktop.NetworkManager.Device.Wireless:WirelessCapabilities, The "WirelessCapabilities" property +
+
org.freedesktop.NetworkManager.DHCP4Config, org.freedesktop.NetworkManager.DHCP4Config +
+
org.freedesktop.NetworkManager.DHCP4Config::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.DHCP4Config:Options, The "Options" property +
+
org.freedesktop.NetworkManager.DHCP6Config, org.freedesktop.NetworkManager.DHCP6Config +
+
org.freedesktop.NetworkManager.DHCP6Config::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.DHCP6Config:Options, The "Options" property +
+
+
+
+

M

+
+
org.freedesktop.NetworkManager, org.freedesktop.NetworkManager +
+
org.freedesktop.NetworkManager.ActivateConnection(), The ActivateConnection() method +
+
org.freedesktop.NetworkManager.AddAndActivateConnection(), The AddAndActivateConnection() method +
+
org.freedesktop.NetworkManager.CheckConnectivity(), The CheckConnectivity() method +
+
org.freedesktop.NetworkManager.DeactivateConnection(), The DeactivateConnection() method +
+
org.freedesktop.NetworkManager.Enable(), The Enable() method +
+
org.freedesktop.NetworkManager.GetAllDevices(), The GetAllDevices() method +
+
org.freedesktop.NetworkManager.GetDeviceByIpIface(), The GetDeviceByIpIface() method +
+
org.freedesktop.NetworkManager.GetDevices(), The GetDevices() method +
+
org.freedesktop.NetworkManager.GetLogging(), The GetLogging() method +
+
org.freedesktop.NetworkManager.GetPermissions(), The GetPermissions() method +
+
org.freedesktop.NetworkManager.SetLogging(), The SetLogging() method +
+
org.freedesktop.NetworkManager.Sleep(), The Sleep() method +
+
org.freedesktop.NetworkManager.state(), The state() method +
+
org.freedesktop.NetworkManager::CheckPermissions, The "CheckPermissions" signal +
+
org.freedesktop.NetworkManager::DeviceAdded, The "DeviceAdded" signal +
+
org.freedesktop.NetworkManager::DeviceRemoved, The "DeviceRemoved" signal +
+
org.freedesktop.NetworkManager::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager::StateChanged, The "StateChanged" signal +
+
org.freedesktop.NetworkManager:ActivatingConnection, The "ActivatingConnection" property +
+
org.freedesktop.NetworkManager:ActiveConnections, The "ActiveConnections" property +
+
org.freedesktop.NetworkManager:AllDevices, The "AllDevices" property +
+
org.freedesktop.NetworkManager:Connectivity, The "Connectivity" property +
+
org.freedesktop.NetworkManager:Devices, The "Devices" property +
+
org.freedesktop.NetworkManager:GlobalDnsConfiguration, The "GlobalDnsConfiguration" property +
+
org.freedesktop.NetworkManager:Metered, The "Metered" property +
+
org.freedesktop.NetworkManager:NetworkingEnabled, The "NetworkingEnabled" property +
+
org.freedesktop.NetworkManager:PrimaryConnection, The "PrimaryConnection" property +
+
org.freedesktop.NetworkManager:PrimaryConnectionType, The "PrimaryConnectionType" property +
+
org.freedesktop.NetworkManager:Startup, The "Startup" property +
+
org.freedesktop.NetworkManager:State, The "State" property +
+
org.freedesktop.NetworkManager:Version, The "Version" property +
+
org.freedesktop.NetworkManager:WimaxEnabled, The "WimaxEnabled" property +
+
org.freedesktop.NetworkManager:WimaxHardwareEnabled, The "WimaxHardwareEnabled" property +
+
org.freedesktop.NetworkManager:WirelessEnabled, The "WirelessEnabled" property +
+
org.freedesktop.NetworkManager:WirelessHardwareEnabled, The "WirelessHardwareEnabled" property +
+
org.freedesktop.NetworkManager:WwanEnabled, The "WwanEnabled" property +
+
org.freedesktop.NetworkManager:WwanHardwareEnabled, The "WwanHardwareEnabled" property +
+
+
+
+

P

+
+
org.freedesktop.NetworkManager.PPP, org.freedesktop.NetworkManager.PPP +
+
org.freedesktop.NetworkManager.PPP.NeedSecrets(), The NeedSecrets() method +
+
org.freedesktop.NetworkManager.PPP.SetIp4Config(), The SetIp4Config() method +
+
org.freedesktop.NetworkManager.PPP.SetIp6Config(), The SetIp6Config() method +
+
org.freedesktop.NetworkManager.PPP.SetState(), The SetState() method +
+
+
+
+

V

+
+
org.freedesktop.NetworkManager.VPN.Connection, org.freedesktop.NetworkManager.VPN.Connection +
+
org.freedesktop.NetworkManager.VPN.Connection::PropertiesChanged, The "PropertiesChanged" signal +
+
org.freedesktop.NetworkManager.VPN.Connection::VpnStateChanged, The "VpnStateChanged" signal +
+
org.freedesktop.NetworkManager.VPN.Connection:Banner, The "Banner" property +
+
org.freedesktop.NetworkManager.VPN.Connection:VpnState, The "VpnState" property +
+
org.freedesktop.NetworkManager.VPN.Plugin, org.freedesktop.NetworkManager.VPN.Plugin +
+
org.freedesktop.NetworkManager.VPN.Plugin.Connect(), The Connect() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive(), The ConnectInteractive() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.Disconnect(), The Disconnect() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets(), The NeedSecrets() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets(), The NewSecrets() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.SetConfig(), The SetConfig() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.SetFailure(), The SetFailure() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config(), The SetIp4Config() method +
+
org.freedesktop.NetworkManager.VPN.Plugin.SetIp6Config(), The SetIp6Config() method +
+
org.freedesktop.NetworkManager.VPN.Plugin::Config, The "Config" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::Failure, The "Failure" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::Ip4Config, The "Ip4Config" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::Ip6Config, The "Ip6Config" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::LoginBanner, The "LoginBanner" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::SecretsRequired, The "SecretsRequired" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin::StateChanged, The "StateChanged" signal +
+
org.freedesktop.NetworkManager.VPN.Plugin:State, The "State" property +
+
+
+
Generated by GTK-Doc V1.24
diff --git a/docs/api/html/license.html b/docs/api/html/license.html index b7944bba..85292624 100644 --- a/docs/api/html/license.html +++ b/docs/api/html/license.html @@ -2,10 +2,10 @@ -Appendix A. License: NetworkManager D-Bus Reference Manual +Appendix A. License: NetworkManager D-Bus API Reference Manual - - + + diff --git a/docs/api/html/manpages.html b/docs/api/html/manpages.html new file mode 100644 index 00000000..27015a54 --- /dev/null +++ b/docs/api/html/manpages.html @@ -0,0 +1,49 @@ + + + + +UNIX Manual Pages: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+

+UNIX Manual Pages

+
+
+NetworkManager — network management daemon +
+
+NetworkManager.conf — NetworkManager configuration file +
+
+nmcli-examples — usage examples of nmcli +
+
+nm-settings — Description of settings and properties of NetworkManager connection profiles +
+
+nm-settings-keyfile — Description of keyfile settings plugin +
+
+nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin +
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html new file mode 100644 index 00000000..7a92c0f9 --- /dev/null +++ b/docs/api/html/nm-settings-ifcfg-rh.html @@ -0,0 +1,1876 @@ + + + + +nm-settings-ifcfg-rh: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings-ifcfg-rh

+

nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin

+
+
+

DESCRIPTION

+

+ NetworkManager is based on the concept of connection profiles that contain + network configuration (see nm-settings(5) for details). The profiles can be + stored in various formats. NetworkManager uses plugins for reading and writing + the data. The plugins can be configured in NetworkManager.conf(5). +

+

+ The ifcfg-rh plugin is used on the Fedora and Red Hat + Enterprise Linux distributions to read/write configuration from/to + the traditional /etc/sysconfig/network-scripts/ifcfg-* files. + Each NetworkManager connection maps to one ifcfg-* file, with + possible usage of keys-* for passwords, route-* + for static IPv4 routes and route6-* for static IPv6 routes. + The plugin currently supports reading and writing Ethernet, Wi-Fi, InfiniBand, + VLAN, Bond, Bridge, and Team connections. Unsupported connection types (such as + WWAN, PPPoE, VPN, or ADSL) are handled by keyfile plugin + (nm-settings-keyfile(5)). + The main reason for using ifcfg-rh plugin is the compatibility + with legacy configurations for ifup and ifdown + (initscripts). +

+
+
+

File Format

+

+ The ifcfg-rh config format is a simple text file containing + VARIABLE="value" lines. The format is described in sysconfig.txt + of initscripts package. Note that the configuration files + may be sourced by initscripts, so they must be valid shell + scripts. That means, for instance, that # character can be used + for comments, strings with spaces must be quoted, special characters must be escaped, + etc. +

+

+ Users can create or modify the ifcfg-rh connection files + manually, even if that is not the recommended way of managing the profiles. + However, if they choose to do that, they must inform NetworkManager about + their changes (see monitor-connection-file in + nm-settings(5), and nmcli con (re)load). +

+

Some ifcfg-rh configuration examples: 

+
Simple DHCP ethernet configuration:
+NAME=ethernet
+UUID=1c4ddf70-01bf-46d6-b04f-47e842bd98da
+TYPE=Ethernet
+BOOTPROTO=dhcp
+DEFROUTE=yes
+PEERDNS=yes
+PEERROUTES=yes
+IPV4_FAILURE_FATAL=no
+ONBOOT=yes
+
+
Simple ethernet configuration with static IP:
+TYPE=Ethernet
+BOOTPROTO=none
+IPADDR=10.1.0.25
+PREFIX=24
+GATEWAY=10.1.0.1
+DEFROUTE=yes
+IPV4_FAILURE_FATAL=no
+IPV6INIT=yes
+IPV6_AUTOCONF=yes
+IPV6_DEFROUTE=yes
+IPV6_PEERDNS=yes
+IPV6_PEERROUTES=yes
+IPV6_FAILURE_FATAL=no
+NAME=ethernet-em2
+UUID=51bb3904-c0fc-4dfe-83b2-0a71e7928c13
+DEVICE=em2
+ONBOOT=yes
+
+
WPA2 Enterprise WLAN (TTLS with inner MSCHAPV2 authentication):
+ESSID="CompanyWLAN"
+MODE=Managed
+KEY_MGMT=WPA-EAP
+TYPE=Wireless
+IEEE_8021X_EAP_METHODS=TTLS
+IEEE_8021X_IDENTITY=joe
+IEEE_8021X_PASSWORD_FLAGS=ask
+IEEE_8021X_INNER_AUTH_METHODS=MSCHAPV2
+IEEE_8021X_CA_CERT=/home/joe/.cert/company.crt
+BOOTPROTO=dhcp
+DEFROUTE=yes
+PEERDNS=yes
+PEERROUTES=yes
+IPV4_FAILURE_FATAL=no
+IPV6INIT=no
+NAME=MyCompany
+UUID=f79848ff-11a6-4810-9e1a-99039dea84c4
+ONBOOT=yes
+
+
Bridge and bridge port configuration:
+ifcfg-bridge:                                ifcfg-bridge-port:
+NAME=bridge                                  NAME=bridge007-port-eth0
+UUID=4be99ce0-c5b2-4764-8b77-ec226e440125    UUID=3ad56c4a-47e1-419b-b0d4-8ad86eb967a3
+DEVICE=bridge007                             DEVICE=eth0
+STP=yes                                      ONBOOT=yes
+TYPE=Bridge                                  TYPE=Ethernet
+BRIDGING_OPTS=priority=32768                 BRIDGE=bridge007
+ONBOOT=yes
+BOOTPROTO=dhcp
+
+
+
Bonding configuration:
+ifcfg-BOND:                                  ifcfg-BOND-slave:
+NAME=BOND                                    NAME=BOND-slave
+UUID=b41888aa-924c-450c-b0f8-85a4f0a51b4a    UUID=9bb048e4-286a-4cc3-b104-007dbd20decb
+DEVICE=bond100                               DEVICE=eth0
+BONDING_OPTS="mode=balance-rr miimon=100"    ONBOOT=yes
+TYPE=Bond                                    TYPE=Ethernet
+BONDING_MASTER=yes                           MASTER=bond100
+ONBOOT=yes                                   SLAVE=yes
+BOOTPROTO=dhcp
+
+
+
Team and team port configuration:
+ifcfg-my_team0:
+DEVICE=team0
+TEAM_CONFIG="{ \"device\": \"team0\", \"runner\": {\"name\": \"roundrobin\"}, \"ports\": {\"eth1\": {}, \"eth2\": {}} }"
+DEVICETYPE=Team
+BOOTPROTO=dhcp
+NAME=team0-profile
+UUID=1d3460a0-7b37-457f-a300-fe8d92da4807
+ONBOOT=yes
+
+ifcfg-my_team0_slave1:
+NAME=team0-slave1
+UUID=d5aed298-c567-4cc1-b808-6d38ecef9e64
+DEVICE=eth1
+ONBOOT=yes
+TEAM_MASTER=team0
+DEVICETYPE=TeamPort
+
+ifcfg-my_team0_slave2:
+NAME=team0-slave2
+UUID=94e75f4e-e5ad-401c-8962-31e0ae5d2215
+DEVICE=eth2
+ONBOOT=yes
+TEAM_MASTER=team0
+DEVICETYPE=TeamPort
+
+

+ The UUID values in the config files must be unique. You can use uuidgen + command line tool to generate such values. Alternatively, you can leave out UUID + entirely. In that case NetworkManager will generate a UUID based on the file name. +

+
+
+

Differences against initscripts

+

+ The main differences of NetworkManager ifcfg-rh plugin and traditional + initscripts are: +

+
++++ + + + + + + + + + + + + + + +

NM_CONTROLLED=yes|no

+ NM_CONTROLLED is NetworkManager-specific variable used by NetworkManager + for determining whether the device of the ifcfg file + should be managed. NM_CONTROLLED=yes is supposed if the variable is not + present in the file. + Note that if you have more ifcfg files for a single + device, NM_CONTROLLED=no in one of the files will cause the device not + to be managed. The profile may not even be the active one. +

New variables

+ NetworkManager has introduced some new variable, not present in initscripts, + to be able to store data for its new features. The variables are marked + as extensions in the tables below. +

Semantic change of variables

 +

+ NetworkManager had to slightly change the semantic for a few variables. +

+
    +

  • PEERDNS - + initscripts interpret PEERDNS=no to mean "never touch resolv.conf". + NetworkManager interprets it to say "never add automatic (DHCP, PPP, VPN, etc.) + nameservers to resolv.conf".

    • +

  • ONBOOT - + initscripts use ONBOOT=yes to mark the devices that are to be activated + during boot. NetworkManager extents this to also mean that this profile + can be used for auto-connecting at any time.

    • +

  • BOOTPROTO - + NetworkManager supports traditional values none (static), + dhcp. But it also allows additional values to + enable new addressing methods. They are autoip for IPv4 + link-local addressing using Avahi daemon and shared for + connection sharing. When shared is used, NetworkManager + assigns the interface 10.42.0.1, or it uses the first static address, + if configured.

    • +
+
+

+ See the next section for detailed mapping of NetworkManager properties and + ifcfg-rh variables. Variable names, format and usage + differences in NetworkManager and initscripts are documented in the tables bellow. +

+
+
+

DETAILS

+

ifcfg-rh plugin variables marked with (+) + are NetworkManager specific extensions not understood by traditional initscripts. +

+
+

Table 69. 802-1x setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
eapIEEE_8021X_EAP_METHODS(+) + EAP method for 802.1X authentication. + +Example: IEEE_8021X_EAP_METHODS=PEAP + +Allowed values: "LEAP", "PWD", "TLS", "PEAP", "TTLS", "FAST"
identityIEEE_8021X_IDENTITY(+) + Identity for EAP authentication methods. + +Example: IEEE_8021X_IDENTITY=itsme
anonymous-identityIEEE_8021X_ANON_IDENTITY(+) + Anonymous identity for EAP authentication methods.
pac-fileIEEE_8021X_PAC_FILE(+) + File with PAC (Protected Access Credential) for EAP-FAST. + +Example: IEEE_8021X_PAC_FILE=/home/joe/my-fast.pac
ca-certIEEE_8021X_CA_CERT(+) + CA certificate for EAP. + +Example: IEEE_8021X_CA_CERT=/home/joe/cacert.crt
ca-path(none) The property is not handled by ifcfg-rh plugin.
subject-matchIEEE_8021X_SUBJECT_MATCH(+) + Substring to match subject of server certificate against. + +Example: IEEE_8021X_SUBJECT_MATCH="Red Hat"
altsubject-matchesIEEE_8021X_ALTSUBJECT_MATCHES(+) + List of strings to be matched against the altSubjectName. + +Example: IEEE_8021X_ALTSUBJECT_MATCHES="s1.domain.cc"
domain-suffix-matchIEEE_8021X_DOMAIN_SUFFIX_MATCH(+) + Suffix to match domain of server certificate against.
client-certIEEE_8021X_CLIENT_CERT(+) + Client certificate for EAP. + +Example: IEEE_8021X_CLIENT_CERT=/home/joe/mycert.crt
phase1-peapverIEEE_8021X_PEAP_VERSION(+) + Use to force a specific PEAP version. + +Allowed values: 0, 1
phase1-peaplabelIEEE_8021X_PEAP_FORCE_NEW_LABEL(+) +noUse to force the new PEAP label during key derivation. + +Allowed values: yes, no
phase1-fast-provisioningIEEE_8021X_FAST_PROVISIONING(+) + Enable in-line provisioning of EAP-FAST credentials. + +Example: IEEE_8021X_FAST_PROVISIONING="allow-auth allow-unauth" + +Allowed values: space-separated list of these values [allow-auth, allow-unauth]
phase2-authIEEE_8021X_INNER_AUTH_METHODS(+) + Inner non-EAP authentication methods. IEEE_8021X_INNER_AUTH_METHODS can contain values both for 'phase2-auth' and 'phase2-autheap' properties. + +Example: IEEE_8021X_INNER_AUTH_METHODS=PAP + +Allowed values: "PAP", "CHAP", "MSCHAP", "MSCHAPV2", "GTC", "OTP", "MD5" and "TLS"
phase2-autheapIEEE_8021X_INNER_AUTH_METHODS(+) + Inner EAP-based authentication methods. Note that IEEE_8021X_INNER_AUTH_METHODS is also used for 'phase2-auth' values. + +Example: IEEE_8021X_INNER_AUTH_METHODS="MSCHAPV2 EAP-TLS" + +Allowed values: "EAP-MD5", "EAP-MSCHAPV2", "EAP-GTC", "EAP-OTP" and "EAP-TLS"
phase2-subject-matchIEEE_8021X_PHASE2_SUBJECT_MATCH(+) + Substring to match subject of server certificate against. + +Example: IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"
phase2-altsubject-matchesIEEE_8021X_PHASE2_ALTSUBJECT_MATCHES(+) +  
phase2-domain-suffix-matchIEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH(+) + Suffix to match domain of server certificate for phase 2 against.
phase2-client-certIEEE_8021X_INNER_CLIENT_CERT(+) + Client certificate for inner EAP method. + +Example: IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crt
passwordIEEE_8021X_PASSWORD(+) + UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
password-flagsIEEE_8021X_PASSWORD_FLAGS(+) + Password flags for IEEE_8021X_PASSWORD password. (see the section called “Secret flag types” for _FLAGS values)
password-raw(none) The property is not handled by ifcfg-rh plugin.
password-raw-flags(none) The property is not handled by ifcfg-rh plugin.
private-keyIEEE_8021X_PRIVATE_KEY(+) + Private key for EAP-TLS. + +Example: IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12
private-key-passwordIEEE_8021X_PRIVATE_KEY_PASSWORD(+) + Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
private-key-password-flagsIEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+) + Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see the section called “Secret flag types” for _FLAGS values)
phase2-private-keyIEEE_8021X_INNER_PRIVATE_KEY(+) + Private key for inner authentication method for EAP-TLS.
phase2-private-key-passwordIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD(+) + Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
phase2-private-key-password-flagsIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS(+) + Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see the section called “Secret flag types” for _FLAGS values)
pin(none) The property is not handled by ifcfg-rh plugin.
pin-flags(none) The property is not handled by ifcfg-rh plugin.
system-ca-certs(none) The property is not handled by ifcfg-rh plugin.
+
+
+

Table 70. bond setting

+
++++++ + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
optionsBONDING_OPTS Bonding options. + +Example: BONDING_OPTS="miimon=100 mode=broadcast"
+
+
+

Table 71. bridge-port setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
priorityBRIDGING_OPTS: priority=32STP priority. + +Allowed values: 0 - 63
path-costBRIDGING_OPTS: path_cost=100STP cost. + +Allowed values: 1 - 65535
hairpin-modeBRIDGING_OPTS: hairpin_mode=yesHairpin mode of the bridge port.
+
+
+

Table 72. bridge setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
mac-addressMACADDR(+) + MAC address of the bridge. Note that this requires a recent kernel support, originally introduced in 3.15 upstream kernel) MACADDR for bridges is an NM extension.
stpSTPnoSpan tree protocol participation.
priorityBRIDGING_OPTS: priority=32768STP priority. + +Allowed values: 0 - 32768
forward-delayDELAY15STP forwarding delay. + +Allowed values: 2 - 30
hello-timeBRIDGING_OPTS: hello_time=2STP hello time. + +Allowed values: 1 - 10
max-ageBRIDGING_OPTS: max_age=20STP maximum message age. + +Allowed values: 6 - 40
ageing-timeBRIDGING_OPTS: ageing_time=300Ethernet MAC ageing time. + +Allowed values: 0 - 1000000
multicast-snoopingBRIDGING_OPTS: multicast_snooping=1IGMP snooping support. + +Allowed values: 0 or 1
+
+
+

Table 73. connection setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
idNAME(+) + User friendly name for the connection profile.
uuidUUID(+) + UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the file).
interface-nameDEVICE Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.
typeTYPE (DEVICETYPE, DEVICE) Base type of the connection. DEVICETYPE is used for teaming connections. + +Example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort + +Allowed values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort
permissionsUSERS(+) + USERS restrict the access for this conenction to certain users only. + +Example: USERS="joe bob"
autoconnectONBOOTyesWhether the connection should be autoconnected (not only while booting).
autoconnect-priorityAUTOCONNECT_PRIORITY(+) +0Connection priority for automatic activation. Connections with higher numbers are preferred when selecting profiles for automatic activation. + +Example: AUTOCONNECT_PRIORITY=20 + +Allowed values: -999 to 999
zoneZONE(+) + Trust level of this connection. The string is usually used for a firewall. + +Example: ZONE=Work
masterMASTER, TEAM_MASTER, BRIDGE Reference to master connection. The variable used depends on the connection type.
slave-typeMASTER, TEAM_MASTER, DEVICETYPE, BRIDGE Slave type doesn't map directly to a variable, but it is recognized using different variables. MASTER for bonding, TEAM_MASTER and DEVICETYPE for teaming, BRIDGE for bridging.
autoconnect-slavesAUTOCONNECT-SLAVES(+) +missing variable means global defaultWhether slaves of this connection should be auto-connected when this connection is activated.
secondariesSECONDARY_UUIDS(+) + UUID of VPN connections that should be activated together with this connection.
gateway-ping-timeoutGATEWAY_PING_TIMEOUT(+) +0If greater than zero, the IP connectivity will be checked by pinging the gateway and waiting for the specified timeout (in seconds). + +Example: GATEWAY_PING_TIMEOUT=5
meteredCONNECTION_METERED Whether the device is metered + +Example: CONNECTION_METERED=yes + +Allowed values: yes,no,unknown
lldpLLDPmissing variable means global defaultwhether LLDP is enabled for the connection + +Example: LLDP=no + +Allowed values: boolean value or 'rx'
+
+
+

Table 74. dcb setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
app-fcoe-flagsDCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLINGnoFCOE flags. + +Example: DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes
app-fcoe-priorityDCB_APP_FCOE_PRIORITY Priority of FCoE frames. + +Allowed values: 0 - 7
app-fcoe-modeDCB_APP_FCOE_MODEfabricFCoE controller mode. + +Allowed values: fabric, vn2vn
app-iscsi-flagsDCB_APP_ISCSI_ENABLE, DCB_APP_ISCSI_ADVERTISE, DCB_APP_ISCSI_WILLINGnoiSCSI flags.
app-iscsi-priorityDCB_APP_ISCSI_PRIORITY Priority of iSCSI frames. + +Allowed values: 0 - 7
app-fip-flagsDCB_APP_FIP_ENABLE, DCB_APP_FIP_ADVERTISE, DCB_APP_FIP_WILLINGnoFIP flags.
app-fip-priorityDCB_APP_FIP_PRIORITY Priority of FIP frames. + +Allowed values: 0 - 7
priority-flow-control-flagsDCB_PFC_ENABLE, DCB_PFC_ADVERTISE, DCB_PFC_WILLINGnoPriority flow control flags.
priority-flow-controlDCB_PFC_UP Priority flow control values. String of 8 "0" and "1", where "0". means "do not transmit priority pause", "1" means "transmit pause". + +Example: DCB_PFC_UP=01101110
priority-group-flagsDCB_PG_ENABLE, DCB_PG_ADVERTISE, DCB_PG_WILLINGnoPriority groups flags.
priority-group-idDCB_PG_ID Priority groups values. String of eight priorities (0 - 7) or "f" (unrestricted). + +Example: DCB_PG_ID=1205f173
priority-group-bandwidthDCB_PG_PCT Priority groups values. Eight bandwidths (in percent), separated with commas. + +Example: DCB_PG_PCT=10,5,10,15,10,10,10,30
priority-bandwidthDCB_PG_UPPCT Priority values. Eight bandwidths (in percent), separated with commas. The sum of the numbers must be 100. + +Example: DCB_PG_UPPCT=7,13,10,10,15,15,10,20
priority-strict-bandwidthDCB_PG_STRICT Priority values. String of eight "0" or "1", where "0" means "may not utilize all bandwidth", "1" means "may utilize all bandwidth". + +Example: DCB_PG_STRICT=01101110
priority-traffic-classDCB_PG_UP2TC Priority values. String of eight trafic class values (0 - 7). + +Example: DCB_PG_UP2TC=01623701
+
+

+ All DCB related configuration is a NetworkManager extension. DCB=yes must be + used explicitly to enable DCB so that the rest of the DCB_* variables can apply. +

+
+

Table 75. infiniband setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
mac-addressHWADDR IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). + +Example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11
mtuMTU MTU of the interface.
transport-modeCONNECTED_MODECONNECTED_MODE=noCONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" mode
p-keyPKEY_ID (and PKEY=yes)PKEY=noInfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV and DEVICE also must be specified. + +Example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002
parentPHYSDEV (PKEY=yes)PKEY=noInfiniBand parent device. + +Example: PHYSDEV=ib0
+
+
+

Table 76. ip-tunnel setting

+
++++++ + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
+
+
+

Table 77. ipv4 setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
methodBOOTPROTOnoneMethod used for IPv4 protocol configuration. + +Allowed values: none, dhcp (bootp), static, ibft, autoip, shared
dnsDNS1, DNS2, ... List of DNS servers. Even if NetworkManager supports many DNS servers, initscripts and resolver only care about the first three, usually. + +Example: DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8
dns-searchDOMAIN List of DNS search domains.
addressesIPADDR, PREFIX, IPADDR1, PREFIX1, ... List of static IP addresses. + +Example: IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16
gatewayGATEWAY Gateway IP address. + +Example: GATEWAY=10.5.5.1
routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, ... List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.
ignore-auto-routesPEERROUTES(+) +yesPEERROUTES has the opposite meaning as 'ignore-auto-routes' property.
ignore-auto-dnsPEERDNSyesPEERDNS has the opposite meaning as 'ignore-auto-dns' property.
dhcp-send-hostnameDHCP_SEND_HOSTNAME(+) +yesWhether DHCP_HOSTNAME should be sent to the DHCP server.
dhcp-hostnameDHCP_HOSTNAME Hostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.
never-defaultDEFROUTE (GATEWAYDEV in /etc/sysconfig/network)yesDEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.
may-failIPV4_FAILURE_FATAL(+) +noIPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.
route-metricIPV4_ROUTE_METRIC(+) +-1IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.
dhcp-client-idDHCP_CLIENT_ID(+) + A string sent to the DHCP server to identify the local machine. + +Example: DHCP_CLIENT_ID=ax-srv-1
dad-timeoutARPING_WAITmissing variable means global default (config override or 3)Timeout (in seconds) for performing DAD before configuring IPv4 addresses. 0 turns off the DAD completely, -1 means default value. + +Example: ARPING_WAIT=2
dhcp-timeoutIPV4_DHCP_TIMEOUT(+) + A timeout after which the DHCP transaction fails in case of no response. + +Example: IPV4_DHCP_TIMEOUT=10
dhcp-fqdnDHCP_FQDN FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used. + +Example: DHCP_FQDN=foo.bar.com
+
+
+

Table 78. ipv6 setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
methodIPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6CIPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=noMethod used for IPv6 protocol configuration. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes
dnsDNS1, DNS2, ... List of DNS servers. NetworkManager uses the variables both for IPv4 and IPv6.
dns-searchDOMAIN List of DNS search domains.
addressesIPV6ADDR, IPV6ADDR_SECONDARIES List of static IP addresses. + +Example: IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"
gatewayIPV6_DEFAULTGW Gateway IP address. + +Example: IPV6_DEFAULTGW=abbe::1
routes(none) List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.
ignore-auto-routesIPV6_PEERROUTES(+) +yesIPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.
ignore-auto-dnsIPV6_PEERDNS(+) +yesIPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.
dhcp-hostnameDHCP_HOSTNAME Hostname to send the DHCP server.
never-defaultIPV6_DEFROUTE(+), (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)IPV6_DEFROUTE=yes (when no variable specified)IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.
may-failIPV6_FAILURE_FATAL(+) +noIPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.
route-metricIPV6_ROUTE_METRIC(+) +-1IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.
ip6-privacyIPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP(+) +noConfigure IPv6 Privacy Extensions for SLAAC (RFC4941). + +Example: IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes + +Allowed values: IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no
addr-gen-modeIPV6_ADDR_GEN_MODEeui64Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217). + +Example: IPV6_ADDR_GEN_MODE=stable-privacy + +Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy
+
+
+

Table 79. macvlan setting

+
++++++ + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
+
+
+

Table 80. team-port setting

+
++++++ + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
configTEAM_PORT_CONFIG Team port configuration in JSON. See man teamd.conf for details.
+
+
+

Table 81. team setting

+
++++++ + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
configTEAM_CONFIG Team configuration in JSON. See man teamd.conf for details.
+
+
+

Table 82. tun setting

+
++++++ + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
+
+
+

Table 83. vlan setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
parentDEVICE or PHYSDEV Parent interface of the VLAN.
idVLAN_ID or DEVICE VLAN identifier.
flagsGVRP, MVRP, VLAN_FLAGS VLAN flags. + +Allowed values: "yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS
ingress-priority-mapVLAN_INGRESS_PRIORITY_MAP Ingress priority mapping. + +Example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5
egress-priority-mapVLAN_EGRESS_PRIORITY_MAP Egress priority mapping. + +Example: VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7
interface-namePHYSDEV and VLAN_ID, or DEVICE VLAN interface name. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID. + +Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
+
+
+

Table 84. vxlan setting

+
++++++ + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
+
+
+

Table 85. 802-3-ethernet setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
port(none) The property is not saved by the plugin.
speed(none) The property is not saved by the plugin.
duplex(none) The property is not saved by the plugin.
auto-negotiate(none) The property is not saved by the plugin.
mac-addressHWADDR Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).
cloned-mac-addressMACADDR Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).
mac-address-blacklistHWADDR_BLACKLIST(+) + It denies usage of the connection for any device whose address is listed. + +Example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"
mtuMTU MTU of the interface.
s390-subchannelsSUBCHANNELS Subchannels for IBM S390 hosts. + +Example: SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00c
s390-nettypeNETTYPE Network type of the S390 host. + +Example: NETTYPE=qeth + +Allowed values: "qeth", "lcs" or "ctc"
s390-optionsOPTIONS and PORTNAME, CTCPROTO, S390 device options. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables.
+
+
+

Table 86. 802-11-wireless-security setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
key-mgmtKEY_MGMT(+) + Key management menthod. + +Allowed values: IEEE8021X, WPA-PSK, WPA-EAP
wep-tx-keyidxDEFAULTKEY1Index of active WEP key. + +Allowed values: 1, 2, 3, 4
auth-algSECURITYMODE(+) + Authentication algorithm for WEP. + +Allowed values: restricted, open, leap
protoWPA_ALLOW_WPA(+), WPA_ALLOW_WPA2(+) +noAllowed WPA protocols, WPA and WPA2 (RSN). + +Allowed values: yes, no
pairwiseCIPHER_PAIRWISE(+) + Restrict pairwise encryption algorithms, specified as a space separated list. + +Allowed values: CCMP, TKIP
groupCIPHER_GROUP(+) + Restrict group/broadcast encryption algorithms, specified as a space separated list. + +Allowed values: CCMP, TKIP, WEP40, WEP104
leap-usernameIEEE_8021X_IDENTITY(+) + Login name for LEAP.
wep-key0KEY1, KEY_PASSPHRASE1(+) + The first WEP key (used in most networks). See also DEFAULTKEY for key index.
wep-key1KEY2, KEY_PASSPHRASE2(+) + WEP key with index 1. See also DEFAULTKEY for key index.
wep-key2KEY3, KEY_PASSPHRASE3(+) + WEP key with index 2. See also DEFAULTKEY for key index.
wep-key3KEY4, KEY_PASSPHRASE4(+) + WEP key with index 3. See also DEFAULTKEY for key index.
wep-key-flagsWEP_KEY_FLAGS(+) + Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see the section called “Secret flag types” for _FLAGS values)
pskWPA_PSK Pre-Shared-Key for WPA networks.
psk-flagsWPA_PSK_FLAGS(+) + Password flags for WPA_PSK_FLAGS. (see the section called “Secret flag types” for _FLAGS values) + +Example: WPA_PSK_FLAGS=user
leap-passwordIEEE_8021X_PASSWORD(+) + Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
leap-password-flagsIEEE_8021X_PASSWORD_FLAGS(+) + Password flags for IEEE_8021X_PASSWORD_FLAGS. (see the section called “Secret flag types” for _FLAGS values)
wep-key-typeKEY<i> or KEY_PASSPHRASE<i>(+) + KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. + +Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey
+
+
+

Table 87. 802-11-wireless setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyIfcfg-rh VariableDefaultDescription
ssidESSID SSID of Wi-Fi network. + +Example: ESSID="Quick Net"
modeMODE Wi-Fi network mode. + +Allowed values: Ad-Hoc, Managed (Auto) [case insensitive]
bandBAND(+) + BAND alone is honored, but CHANNEL overrides BAND since it implies a band. + +Example: BAND=bg + +Allowed values: a, bg
channelCHANNEL Channel used for the Wi-Fi communication. Channels greater than 14 mean "a" band, otherwise the band is "bg". + +Example: CHANNEL=6
bssidBSSID(+) + Restricts association only to a single AP. + +Example: BSSID=00:1E:BD:64:83:21
rate(none) This property is not handled by ifcfg-rh plugin.
tx-power(none) This property is not handled by ifcfg-rh plugin.
mac-addressHWADDR Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).
cloned-mac-addressMACADDR Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).
mac-address-blacklistHWADDR_BLACKLIST(+) + It denies usage of the connection for any device whose address is listed.
seen-bssids(none) This property is not handled by ifcfg-rh plugin.
mtuMTU MTU of the wireless interface.
hiddenSSID_HIDDEN(+) + Whether the network hides the SSID.
powersavePOWERSAVE(+) + Enables or disables Wi-Fi power saving. + +Example: POWERSAVE=enable + +Allowed values: default, ignore, enable, disable
mac-address-randomizationMAC_ADDRESS_RANDOMIZATION(+) + Enables or disables Wi-Fi MAC address randomization. + +Example: MAC_ADDRESS_RANDOMIZATION=always + +Allowed values: default, never, always
security(none) This property is deprecated and not handled by ifcfg-rh-plugin.
+
+

The following settings are not supported by ifcfg-rh plugin:

+

adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn

+
+

Secret flags

+

+ Each secret property in a NetworkManager setting has an associated + flags property that describes how to handle that secret. + In the fcfg-rh plugin variables for secret flags have a + _FLAGS suffix. The variables contain one or more of the + following values (space separated). Missing (or empty) *_FLAGS variable means + that the password is owned by NetworkManager. +

+
    +

  • user - a user-session secret agent is responsible for providing + and storing this secret; when it is required, agents will be asked to provide it.

    • +

  • ask - the associated password is not saved but it will be + requested from the user each time it is required.

    • +

  • unused - in some situations it cannot be automatically determined + that a secret is required or not. This flag hints that the secret is not required and should + not be requested from the user.

    • +
+
+
+
+

AUTHOR

+

NetworkManager developers

+
+
+

FILES

+

/etc/sysconfig/network-scripts/ifcfg-*

+

/etc/sysconfig/network-scripts/keys-*

+

/etc/sysconfig/network-scripts/route-*

+

/etc/sysconfig/network-scripts/route6-*

+

/usr/share/doc/initscripts/sysconfig.txt

+
+
+

SEE ALSO

+

https://developer.gnome.org/NetworkManager/unstable/ref-settings.html

+

nm-settings(5), nm-settings-keyfile(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nm-settings-keyfile.html b/docs/api/html/nm-settings-keyfile.html new file mode 100644 index 00000000..35135634 --- /dev/null +++ b/docs/api/html/nm-settings-keyfile.html @@ -0,0 +1,525 @@ + + + + +nm-settings-keyfile: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings-keyfile

+

nm-settings-keyfile — Description of keyfile settings plugin

+
+
+

DESCRIPTION

+

+ NetworkManager is based on the concept of connection profiles that contain + network configuration (see nm-settings(5) for details). The profiles can be + stored in various formats. NetworkManager uses plugins for reading and writing + the data. The plugins can be configured in NetworkManager.conf(5). +

+

+ The keyfile plugin is the generic plugin that supports all + the connection types and capabilities that NetworkManager has. It writes files + out in a .ini-style format in /etc/NetworkManager/system-connections/. + This plugin is always enabled and will automatically be used to store + any connections that are not supported by any other active plugin. + For security, it will ignore files that are readable or writable by any user + or group other than 'root' since private keys and passphrases may be stored + in plaintext inside the file. +

+
+
+

File Format

+

+ The keyfile config format is a simple .ini-style + format. It consists of sections (groups) of key-value pairs. Each section + corresponds to a setting name as described in the settings specification + (nm-settings(5)). Each configuration key/value + pair in the section is one of the properties listed in the settings + specification. The majority of properties of the specification is written + in the same format into the keyfile too. However + some values are inconvenient for people to use. These are stored in the + files in more readable ways. These properties are described bellow. + An example could be IP addresses that are not written as integer arrays, + but more reasonably as "1.2.3.4/12 1.2.3.254". + More information of the generic key file format can be found at + + GLib key file format (Lines beginning with a '#' are comments, + lists are separated by character ; etc.). +

+

+ Users can create or modify the keyfile connection files + manually, even if that is not the recommended way of managing the profiles. + However, if they choose to do that, they must inform NetworkManager about + their changes (see monitor-connection-file in + nm-settings(5) and nmcli con (re)load). +

+

Examples of keyfile configuration. 

+
A sample configuration for an ethernet network:
+[connection]
+id=Main eth0
+uuid=27afa607-ee36-43f0-b8c3-9d245cdc4bb3
+type=802-3-ethernet
+autoconnect=true
+
+[ipv4]
+method=auto
+
+[802-3-ethernet]
+mac-address=00:23:5a:47:1f:71
+
+
A sample configuration for WPA-EAP (PEAP with MSCHAPv2) and always-ask secret:
+[connection]
+id=CompanyWIFI
+uuid=cdac6154-a33b-4b15-9904-666772cfa5ee
+type=wifi
+autoconnect=false
+
+[wifi]
+ssid=CorpWLAN
+mode=infrastructure
+security=802-11-wireless-security
+
+[wifi-security]
+key-mgmt=wpa-eap
+
+[ipv4]
+method=auto
+
+[ipv6]
+method=auto
+
+[802-1x]
+eap=peap;
+identity=joe
+ca-cert=/home/joe/.cert/corp.crt
+phase1-peapver=1
+phase2-auth=mschapv2
+password-flags=2
+
+
A sample configuration for openvpn:
+[connection]
+id=RedHat-openvpn
+uuid=7f9b3356-b210-4c0e-8123-bd116c9c280f
+type=vpn
+timestamp=1385401165
+
+[vpn]
+service-type=org.freedesktop.NetworkManager.openvpn
+connection-type=password
+password-flags=3
+remote=ovpn.my-company.com
+cipher=AES-256-CBC
+reneg-seconds=0
+port=443
+username=joe
+ca=/etc/openvpn/ISCA.pem
+tls-remote=ovpn.my-company.com
+
+[ipv6]
+method=auto
+
+[ipv4]
+method=auto
+ignore-auto-dns=true
+never-default=true
+
+
A sample configuration for a bridge and a bridge port:
+[connection]                                 [connection]
+id=MainBridge                                id=br-port-1
+uuid=171ae855-a0ab-42b6-bd0c-60f5812eea9d    uuid=d6e8ae98-71f8-4b3d-9d2d-2e26048fe794
+interface-name=MainBridge                    interface-name=em1
+type=bridge                                  type=ethernet
+                                             master=MainBridge
+[bridge]                                     slave-type=bridge
+interface-name=MainBridge
+
+
A sample configuration for a VLAN:
+[connection]
+id=VLAN for building 4A
+uuid=8ce1c9e0-ce7a-4d2c-aa28-077dda09dd7e
+interface-name=VLAN-4A
+type=vlan
+
+[vlan]
+interface-name=VLAN-4A
+parent=eth0
+id=4
+
+
+
+

DETAILS

+

keyfile plugin variables for the majority of NetworkManager + properties have one-to-one mapping. It means a NetworkManager property is stored + in the keyfile as a variable of the same name and in the same format. + There are several exceptions to this rule, mainly for making keyfile syntax easier + for humans. The exceptions handled specially by keyfile + plugin are listed bellow. Refer to + nm-settings(5) + for all available settings and properties and their description. +

+

Name aliases.  + Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore + keyfile introduces aliases that can be used instead of the names. +

+ + + + + +
setting name keyfile alias
802-3-ethernet = ethernet
802-11-wireless = wifi
802-11-wireless-security = wifi-security
+
+

Table 61. bridge setting (section)

+
++++++ + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) + +Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;
+
+
+

Table 62. infiniband setting (section)

+
++++++ + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) + +Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
+
+
+

Table 63. ipv4 setting (section)

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
dnsdnslist of DNS IP addressesList of DNS servers. + +Example: dns=1.2.3.4;8.8.8.8;8.8.4.4;
addressesaddress1, address2, ...address/plenList of static IP addresses. + +Example: address1=192.168.100.100/24 address2=10.1.1.5/24
gatewaygatewaystringGateway IP addresses as a string. + +Example: gateway=192.168.100.1
routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. + +Example: route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16
+
+
+

Table 64. ipv6 setting (section)

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
dnsdnslist of DNS IP addressesList of DNS servers. + +Example: dns=2001:4860:4860::8888;2001:4860:4860::8844;
addressesaddress1, address2, ...address/plenList of static IP addresses. + +Example: address1=abbe::cafe/96 address2=2001::1234
gatewaygatewaystringGateway IP addresses as a string. + +Example: gateway=abbe::1
routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. + +Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
+
+
+

Table 65. serial setting (section)

+
++++++ + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
parityparity'e', 'o', or 'n'The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none. + +Example: parity=n
+
+
+

Table 66. vpn setting (section)

+
++++++ + + + + + + + + + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
dataseparate variables named after keys of the dictionary The keys of the data dictionary are used as variable names directly under [vpn] section. + +Example: remote=ovpn.corp.com cipher=AES-256-CBC username=joe
secretsseparate variables named after keys of the dictionary The keys of the secrets dictionary are used as variable names directly under [vpn-secrets] section. + +Example: password=Popocatepetl
+
+
+

Table 67. 802-3-ethernet setting (section)

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)
cloned-mac-addresscloned-mac-addressususal hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).
mac-address-blacklistmac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. + +Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
+
+
+

Table 68. 802-11-wireless setting (section)

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyKeyfile VariableFormatDescription
ssidssidstring (or decimal-byte list - obsolete)SSID of Wi-Fi network. + +Example: ssid=Quick Net
mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).
cloned-mac-addresscloned-mac-addressususal hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).
mac-address-blacklistmac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. + +Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
+
+
+

Secret flags

+

+ Each secret property in a NetworkManager setting has an associated flags + property that describes how to handle that secret. In the keyfile plugin, + the value of -flags variable is a decimal number (0 - 7) defined as a sum + of the following values: +

+
    +

  • 0 - (NM owned) - the system is responsible for providing and storing this secret.

    • +

  • 1 - (agent-owned) - a user-session secret agent is responsible for providing + and storing this secret; when it is required, agents will be asked to provide it.

    • +

  • 2 - (not-saved) - this secret should not be saved but should be requested + from the user each time it is required.

    • +

  • 4 - (not-required) - in some situations it cannot be automatically determined + that a secret is required or not. This flag hints that the secret is not required + and should not be requested from the user.

    • +
+
+
+
+

AUTHOR

+

NetworkManager developers

+
+
+

FILES

+

/etc/NetworkManager/system-connections/*

+
+
+

SEE ALSO

+

https://developer.gnome.org/NetworkManager/unstable/ref-settings.html

+

nm-settings(5), nm-settings-ifcfg-rh(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nm-settings.html b/docs/api/html/nm-settings.html new file mode 100644 index 00000000..7a9b75e9 --- /dev/null +++ b/docs/api/html/nm-settings.html @@ -0,0 +1,2567 @@ + + + + +nm-settings: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nm-settings

+

nm-settings — Description of settings and properties of NetworkManager connection profiles

+
+
+

DESCRIPTION

+

+ NetworkManager is based on a concept of connection profiles, sometimes referred to as + connections only. These connection profiles contain a network configuration. When + NetworkManager activates a connection profile on a network device the configuration will + be applied and an active network connection will be established. Users are free to create + as many connection profiles as they see fit. Thus they are flexible in having various network + configurations for different networking needs. The connection profiles are handled by + NetworkManager via settings service and are exported on D-Bus + (/org/freedesktop/NetworkManager/Settings/<num> objects). + The conceptual objects can be described as follows: +

+
++++ + + + + +

Connection (profile)

+ A specific, encapsulated, independent group of settings describing + all the configuration required to connect to a specific network. + It is referred to by a unique identifier called the UUID. A connection + is tied to a one specific device type, but not necessarily a specific + hardware device. It is composed of one or more Settings + objects. +

+
++++ + + + + +

Setting

+ A group of related key/value pairs describing a specific piece of a + Connection (profile). Settings keys and allowed values are + described in the tables below. Keys are also referred to as properties. + Developers can find the setting objects and their properties in the libnm-util + sources. Look for the class_init functions near the bottom of + each setting source file. +

+
+

+ The settings and properties shown in tables below list all available connection + configuration options. However, note that not all settings are applicable to all + connection types. NetworkManager provides a command-line tool nmcli + that allows direct configuration of the settings and properties according to a connection + profile type. nmcli connection editor has also a built-in + describe command that can display description of particular settings + and properties of this page. +

+ ++++ + +
+
+
+

Table 31. 802-1x setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.
anonymous-identitystring Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.
ca-certbyte array Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
ca-pathstring UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.
client-certbyte array Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.
domain-suffix-matchstring Constraint 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.
eaparray 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.
identitystring Identity string for EAP authentication methods. Often the user's user or login name.
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-filestring UTF-8 encoded file path containing PAC for EAP-FAST.
passwordstring UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property. (see the section called “Secret flag types” for flag values)
password-rawbyte array Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-raw-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password-raw" property. (see the section called “Secret flag types” for flag values)
phase1-fast-provisioningstring Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.
phase1-peaplabelstring Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.
phase1-peapverstring Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.
phase2-altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.
phase2-authstring Specifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
phase2-autheapstring Specifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
phase2-ca-certbyte array Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
phase2-ca-pathstring UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.
phase2-client-certbyte array Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
phase2-domain-suffix-matchstring Constraint 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 during the inner "phase 2" authentication. 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.
phase2-private-keybyte array Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate.
phase2-private-key-passwordstring The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS12 format key.
phase2-private-key-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-private-key-password" property. (see the section called “Secret flag types” for flag values)
phase2-subject-matchstring Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.
pinstring PIN used for EAP authentication methods.
pin-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "pin" property. (see the section called “Secret flag types” for flag values)
private-keybyte array Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
private-key-passwordstring The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS12 format key.
private-key-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "private-key-password" property. (see the section called “Secret flag types” for flag values)
subject-matchstring Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.
system-ca-certsbooleanFALSEWhen TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
+
+
+

Table 32. adsl setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
encapsulationstring Encapsulation of ADSL connection. Can be "vcmux" or "llc".
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".
passwordstring Password used to authenticate with the ADSL service.
password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property. (see the section called “Secret flag types” for flag values)
protocolstring ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".
usernamestring Username used to authenticate with the ADSL service.
vciuint320VCI of ADSL connection
vpiuint320VPI of ADSL connection
+
+
+

Table 33. bluetooth setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
bdaddrbyte array The Bluetooth address of the device.
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".
typestring Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
+
+
+

Table 34. bond setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.
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".
optionsdict 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]).
+
+
+

Table 35. bridge setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
ageing-timeuint32300The Ethernet MAC address aging time, in seconds.
forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds.
hello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds.
interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.
mac-addressbyte array If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match.
max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds.
multicast-snoopingbooleanTRUEControls 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.
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".
priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.
stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.
+
+
+

Table 36. bridge-port setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
hairpin-modebooleanFALSEEnables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.
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-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port.
priorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.
+
+
+

Table 37. cdma setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
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".
numberstring The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (777) is used when required.
passwordstring 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.
password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property. (see the section called “Secret flag types” for flag values)
usernamestring The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
+
+
+

Table 38. connection setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
autoconnectbooleanTRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.
autoconnect-priorityint320The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority.
autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32) Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.
gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
idstring A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
interface-namestring The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
lldpint32-1Whether LLDP is enabled for the connection.
masterstring Interface name of the master device or UUID of the master connection.
meteredNMMetered (int32) Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
namestringconnectionThe 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".
permissionsarray 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 a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.
read-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.
secondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.
slave-typestring Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.
timestampuint640The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
typestring Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
uuidstring A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
zonestring The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.
+
+
+

Table 39. dcb setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
app-fcoe-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
app-fcoe-modestring"fabric"The FCoE controller mode; either "fabric" (default) or "vn2vn".
app-fcoe-priorityint32-1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
app-fip-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
app-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-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-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.
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-bandwidtharray of uint32[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 percent.
priority-flow-controlarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]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-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).
priority-group-bandwidtharray of uint32[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 percent.
priority-group-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
priority-group-idarray of uint32[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-strict-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.
priority-traffic-classarray of uint32[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.
+
+
+

Table 40. generic setting

+
++++++ + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue 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".
+
+
+

Table 41. gsm setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
apnstring The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
device-idstring 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.
home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
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-idstring 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.
numberstring 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.
passwordstring 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.
password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property. (see the section called “Secret flag types” for flag values)
pinstring If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.
pin-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "pin" property. (see the section called “Secret flag types” for flag values)
sim-idstring The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
sim-operator-idstring A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.
usernamestring The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
+
+
+

Table 42. infiniband setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
mac-addressbyte array If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
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-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.
parentstring The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".
transport-modestring The IP-over-InfiniBand transport mode. Either "datagram" or "connected".
+
+
+

Table 43. ipv4 setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
address-dataarray of vardict Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
addressesarray 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-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 3 seconds). A value greater than zero is a timeout in milliseconds.
dhcp-client-idstring A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.
dhcp-fqdnstring If 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-hostnamestring If 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-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.
dhcp-timeoutint320A timeout for a DHCP transaction in seconds.
dnsarray of uint32[]Array of IP addresses of DNS servers (as network-byte-order integers)
dns-optionsarray of string[]Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
dns-searcharray of string[]Array of DNS search domains.
gatewaystring The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
ignore-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-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-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.
methodstring 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".
never-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-dataarray of vardict Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'gateway' entry, containing the gateway IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
routesarray of array of uint32[]Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)
+
+
+

Table 44. ipv6 setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
addr-gen-modeint321Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", "stable-privacy" or unset. If the property is set to "eui64", the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of "stable-privacy" enables use of cryptographically secure hash of a secret host-specific key along with the connection identification and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. Leaving this unset causes a default that could be subject to change in future versions to be used. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
address-dataarray of vardict Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
addressesarray of legacy IPv6 address struct (a(ayuay))[]Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.
dad-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 3 seconds). A value greater than zero is a timeout in milliseconds.
dhcp-hostnamestring If 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-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.
dhcp-timeoutint320A timeout for a DHCP transaction in seconds.
dnsarray of byte array[]Array of IP addresses of DNS servers (in network byte order)
dns-optionsarray of string[]Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
dns-searcharray of string[]Array of DNS search domains.
gatewaystring The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
ignore-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-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-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-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.
methodstring 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".
never-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-dataarray of vardict Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
routesarray of legacy IPv6 route struct (a(ayuayu))[]Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.
+
+
+

Table 45. ip-tunnel setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
encapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.
flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
input-keystring The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
localstring The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
modeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).
mtuuint320None
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-keystring The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
parentstring If 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-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel.
remotestring The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
+
+
+

Table 46. macvlan setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
modeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
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".
parentstring If 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.
promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode.
tapbooleanFALSEWhether the interface should be a MACVTAP.
+
+
+

Table 47. 802-11-olpc-mesh setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
channeluint320Channel on which the mesh network to join is located.
dhcp-anycast-addressbyte array Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.
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".
ssidbyte array SSID of the mesh network to join.
+
+
+

Table 48. ppp setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
bauduint320If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.
crtsctsbooleanFALSEIf TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.
lcp-echo-failureuint320If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.
lcp-echo-intervaluint320If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.
mppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.
mruuint320If 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.
mtuuint320If non-zero, instruct pppd to send packets no larger than the specified size.
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-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested.
noauthbooleanTRUEIf 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.
nobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested.
nodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested.
refuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used.
refuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used.
refuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used.
refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used.
refuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used.
require-mppebooleanFALSEIf TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.
require-mppe-128booleanFALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.
+
+
+

Table 49. pppoe setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
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".
passwordstring Password used to authenticate with the PPPoE service.
password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property. (see the section called “Secret flag types” for flag values)
servicestring If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.
usernamestring Username used to authenticate with the PPPoE service.
+
+
+

Table 50. serial setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
bauduint3257600Speed 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.
bitsuint328Byte-width of the serial communication. The 8 in "8n1" for example.
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".
paritybyte The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.
send-delayuint640Time to delay between each byte sent to the modem, in microseconds.
stopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.
+
+
+

Table 51. team setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
configstring The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.
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".
+
+
+

Table 52. team-port setting

+
++++++ + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
configstring The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
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".
+
+
+

Table 53. tun setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
groupstring The group ID which will own the device. If set to NULL everyone will be able to use the device.
modeuint321The 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.
multi-queuebooleanFALSEIf 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.
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".
ownerstring The user ID which will own the device. If set to NULL everyone will be able to use the device.
pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
+
+
+

Table 54. vlan setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
egress-priority-maparray of string[]For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
flagsNMVlanFlags (uint32) One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
iduint320The 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.
ingress-priority-maparray of string[]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".
interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.
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".
parentstring 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.
+
+
+

Table 55. vpn setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
datadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.
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".
persistentbooleanFALSEIf 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.
secretsdict 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-typestring D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
timeoutuint320Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
user-namestring If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.
+
+
+

Table 56. vxlan setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
ageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel.
destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
iduint320Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.
l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated.
l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated.
learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
localstring If given, specifies the source IP address to use in outgoing packets.
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".
parentstring If given, specifies the parent interface name or parent connection UUID.
proxybooleanFALSESpecifies whether ARP proxy is turned on.
remotestring Specifies 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.
rscbooleanFALSESpecifies whether route short circuit is turned on.
source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
tosuint320Specifies the TOS value to use in outgoing packets.
ttluint320Specifies the time-to-live value to use in outgoing packets.
+
+
+

Table 57. wimax setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
mac-addressbyte array If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1
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-namestring Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
+
+
+

Table 58. 802-3-ethernet setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
auto-negotiatebooleanTRUEIf TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set.
cloned-mac-addressbyte array If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.
duplexstring If specified, request that the device only use the specified duplex mode. Either "half" or "full".
mac-addressbyte array 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).
mac-address-blacklistarray of string[]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).
mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
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".
portstring Specific port type to use if multiple the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. If the device supports only one port type, this setting is ignored.
s390-nettypestring s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.
s390-optionsdict of string to string{}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]).
s390-subchannelsarray of string[]Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.
speeduint320If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.
wake-on-lanuint321The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).
wake-on-lan-passwordstring If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.
+
+
+

Table 59. 802-11-wireless setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
bandstring 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.
bssidbyte array If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.
channeluint320Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.
cloned-mac-addressbyte array If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.
hiddenbooleanFALSEIf 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.
mac-addressbyte array If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mac-address-blacklistarray of string[]A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
mac-address-randomizationuint320One 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).
modestring Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.
mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
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".
powersaveuint320One 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.
rateuint320If 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.
securityNone 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.
seen-bssidsarray of string[]A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.
ssidbyte array SSID of the Wi-Fi network. Must be specified.
tx-poweruint320If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.
+
+
+

Table 60. 802-11-wireless-security setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
auth-algstring When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.
grouparray of string[]A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".
key-mgmtstring Key management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.
leap-passwordstring The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
leap-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "leap-password" property. (see the section called “Secret flag types” for flag values)
leap-usernamestring The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
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".
pairwisearray of string[]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".
protoarray of string[]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.
pskstring Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.
psk-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "psk" property. (see the section called “Secret flag types” for flag values)
wep-key-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. (see the section called “Secret flag types” for flag values)
wep-key-typeNMWepKeyType (uint32) Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.
wep-key0string Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key1string Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key2string Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key3string Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-tx-keyidxuint320When 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.
+
+
+

Secret flag types:

+

+ Each secret property in a setting has an associated flags property + that describes how to handle that secret. The flags property is a bitfield + that contains zero or more of the following values logically OR-ed together. +

+
    +

  • 0x0 (none) - the system is responsible for providing and storing this secret.

    • +

  • 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing + this secret; when it is required, agents will be asked to provide it.

    • +

  • 0x2 (not-saved) - this secret should not be saved but should be requested from the user + each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, + or if the user simply does not want to save the secret.

    • +

  • 0x4 (not-required) - in some situations it cannot be automatically determined that a secret + is required or not. This flag hints that the secret is not required and should not be requested from the user.

    • +
+
+
+
+

AUTHOR

+

NetworkManager developers

+
+
+

FILES

+

/etc/NetworkManager/system-connections

+

or distro plugin-specific location

+
+
+

SEE ALSO

+

https://wiki.gnome.org/Projects/NetworkManager/ConfigurationSpecification

+

NetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5)

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html new file mode 100644 index 00000000..e7ac079b --- /dev/null +++ b/docs/api/html/nmcli-examples.html @@ -0,0 +1,610 @@ + + + + +nmcli-examples: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

nmcli-examples

+

nmcli-examples — usage examples of nmcli

+
+
+

Synopsis

+

nmcli [OPTIONS...]

+
+
+

Description

+

+ nmcli is a command-line client for NetworkManager. It + allows controlling NetworkManager and reporting its status. For more information + please refer to nmcli(1) + manual page. +

+

+ The purpose of this manual page is to provide you with various examples and + usage scenarios of nmcli. +

+

Note: this page has "work-in-progress" status.

+
+
+

Examples

+
+

Example 1. Listing available Wi-Fi APs

+
+

+$ nmcli device wifi list
+
+
+*  SSID               MODE    CHAN  RATE       SIGNAL  BARS  SECURITY
+   netdatacomm_local  Infra   6     54 Mbit/s  37      ▂▄__  WEP
+*  F1                 Infra   11    54 Mbit/s  98      ▂▄▆█  WPA1
+   LoremCorp          Infra   1     54 Mbit/s  62      ▂▄▆_  WPA2 802.1X
+   Internet           Infra   6     54 Mbit/s  29      ▂___  WPA1
+   HPB110a.F2672A     Ad-Hoc  6     54 Mbit/s  22      ▂___  --
+   Jozinet            Infra   1     54 Mbit/s  19      ▂___  WEP
+   VOIP               Infra   1     54 Mbit/s  20      ▂___  WEP
+   MARTINA            Infra   4     54 Mbit/s  32      ▂▄__  WPA2
+   N24PU1             Infra   7     11 Mbit/s  22      ▂___  --
+   alfa               Infra   1     54 Mbit/s  67      ▂▄▆_  WPA2
+   bertnet            Infra   5     54 Mbit/s  20      ▂___  WPA1 WPA2
+
+
+
+

+ This command shows how to list available Wi-Fi networks (APs). You can also use + --fields option for displaying different columns. + nmcli -f all dev wifi list will show all of them. +

+
+

Example 2. Showing general information and properties for a Wi-Fi interface

+
+

+$ nmcli -p -f general,wifi-properties device show wlan0
+
+
+===============================================================================
+                            Device details (wlan0)
+===============================================================================
+GENERAL.DEVICE:                         wlan0
+GENERAL.TYPE:                           wifi
+GENERAL.VENDOR:                         Intel Corporation
+GENERAL.PRODUCT:                        PRO/Wireless 5100 AGN [Shiloh] Network Connection
+GENERAL.DRIVER:                         iwlwifi
+GENERAL.DRIVER-VERSION:                 3.8.13-100.fc17.x86_64
+GENERAL.FIRMWARE-VERSION:               8.83.5.1 build 33692
+GENERAL.HWADDR:                         00:1E:65:37:A1:D3
+GENERAL.MTU:                            1500
+GENERAL.STATE:                          100 (connected)
+GENERAL.REASON:                         0 (No reason given)
+GENERAL.UDI:                            /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlan0
+GENERAL.IP-IFACE:                       wlan0
+GENERAL.IS-SOFTWARE:                    no
+GENERAL.NM-MANAGED:                     yes
+GENERAL.AUTOCONNECT:                    yes
+GENERAL.FIRMWARE-MISSING:               no
+GENERAL.CONNECTION:                     My Alfa WiFi
+GENERAL.CON-UUID:                       85194f4c-d496-4eec-bae0-d880b4cbcf26
+GENERAL.CON-PATH:                       /org/freedesktop/NetworkManager/ActiveConnection/10
+-------------------------------------------------------------------------------
+WIFI-PROPERTIES.WEP:                    yes
+WIFI-PROPERTIES.WPA:                    yes
+WIFI-PROPERTIES.WPA2:                   yes
+WIFI-PROPERTIES.TKIP:                   yes
+WIFI-PROPERTIES.CCMP:                   yes
+WIFI-PROPERTIES.AP:                     no
+WIFI-PROPERTIES.ADHOC:                  yes
+-------------------------------------------------------------------------------
+
+
+
+

+ This command shows information about a Wi-Fi device. +

+
+

Example 3. Listing NetworkManager polkit permissions

+
+

+$ nmcli general permissions
+
+
+PERMISSION                                                VALUE
+org.freedesktop.NetworkManager.enable-disable-network     yes
+org.freedesktop.NetworkManager.enable-disable-wifi        yes
+org.freedesktop.NetworkManager.enable-disable-wwan        yes
+org.freedesktop.NetworkManager.enable-disable-wimax       yes
+org.freedesktop.NetworkManager.sleep-wake                 no
+org.freedesktop.NetworkManager.network-control            yes
+org.freedesktop.NetworkManager.wifi.share.protected       yes
+org.freedesktop.NetworkManager.wifi.share.open            yes
+org.freedesktop.NetworkManager.settings.modify.system     yes
+org.freedesktop.NetworkManager.settings.modify.own        yes
+org.freedesktop.NetworkManager.settings.modify.hostname   auth
+
+
+
+

+ This command shows configured polkit permissions for various NetworkManager + operations. These permissions or actions (using polkit language) are configured + by a system administrator and are not meant to be changed by users. The usual + place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. + pkaction command can display description for polkit actions. +

+

+pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose
+
+

+ More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. +

+
+

Example 4. Listing NetworkManager log level and domains

+
+

+$ nmcli general logging
+
+
+LEVEL  DOMAINS
+INFO   PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,AUTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC,WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DCB,DISPATCH
+
+
+
+

+ This command shows current NetworkManager logging status. +

+
+

Example 5. Changing NetworkManager logging

+

+$ nmcli g log level DEBUG domains CORE,ETHER,IP
+$ nmcli g log level INFO domains DEFAULT
+
+
+

+ The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and + IP domains. The second command restores the default logging state. Please refer to the + NetworkManager.conf(5) manual page + for available logging levels and domains. +

+
+

Example 6. Adding a bonding master and two slave connection profiles

+

+$ nmcli con add type bond ifname mybond0 mode active-backup
+$ nmcli con add type ethernet ifname eth1 master mybond0
+$ nmcli con add type ethernet ifname eth2 master mybond0
+
+
+

+ This example demonstrates adding a bond master connection and two slaves. The + first command adds a master bond connection, naming the bonding interface + mybond0 and using active-backup mode. + The next two commands add slaves connections, both enslaved to mybond0. + The first slave will be bound to eth1 interface, the second to + eth2. +

+
+

Example 7. Adding a team master and two slave connection profiles

+

+$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf
+$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1
+$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1
+
+
+

+ This example demonstrates adding a team master connection profile and two slaves. It is + very similar to the bonding example. The first command adds a master team profile, naming + the team interface and the profile Team1. The team configuration + for the master is read from team1-master-json.conf file. Later, you can + change the configuration with modify command + (nmcli con modify Team1 team.config team1-master-another-json.conf). + The last two commands add slaves profiles, both enslaved to Team1. + The first slave will be bound to em1 interface, the second to + em2. The slaves don't specify config and thus + teamd will use its default configuration. You will activate the whole setup + by activating both slaves: +

+

+$ nmcli con up Team1-slave1
+$ nmcli con up Team1-slave2
+
+

+ By default, the created profiles are marked for auto-activation. But if another + connection has been activated on the device, the new profile won't activate + automatically and you need to activate it manually. +

+
+

Example 8. Adding a bridge and two slave profiles

+

+$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge
+$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge
+$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge
+$ nmcli con modify TowerBridge bridge.stp no
+
+
+

+ This example demonstrates adding a bridge master connection and two slaves. The + first command adds a master bridge connection, naming the bridge interface and + the profile as TowerBridge. + The next two commands add slaves profiles, both will be enslaved to + TowerBridge. + The first slave will be tied to ens3 interface, the second to + ens4. + The last command will disable 802.1D STP for the TowerBridge profile. +

+
+

Example 9. Adding an ethernet connection profile with manual IP configuration

+
+        
+$ nmcli con add con-name my-con-em1 ifname em1 type ethernet ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe
+$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"
+$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4
+$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"
+$ nmcli -p con show my-con-em1
+        
+
+
+

+ The first command adds an Ethernet connection profile named my-con-em1 + that is bound to interface name em1. The profile is configured + with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. + The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). + Gateway entry will become the default route if this profile is activated on em1 interface + (and there is no connection with higher priority). The next two addresses do not + specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. + The second, third and fourth commands modify DNS parameters of the new connection profile. + The last con show command displays the profile so that all + parameters can be reviewed. +

+
+

Example 10. Escaping colon characters in tabular mode

+
+
+        
+$ nmcli -t -f general -e yes -m tab dev show eth0
+        
+
+
+GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reason given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no:ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkManager/ActiveConnection/9
+
+
+
+

+ This example shows escaping colon characters in tabular mode. It may be + useful for script processing, because ':' is used as a field separator. +

+
+

Example 11. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive

+
+ + + + + + + + 
1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
#!/bin/bash
+export LC_ALL=C
+
+enable_disable_wifi ()
+{
+    result=$(nmcli dev | grep "ethernet" | grep -w "connected")
+    if [ -n "$result" ]; then
+        nmcli radio wifi off
+    else
+        nmcli radio wifi on
+    fi
+}
+
+if [ "$2" = "up" ]; then
+    enable_disable_wifi
+fi
+
+if [ "$2" = "down" ]; then
+    enable_disable_wifi
+fi
+
+ +
+

+ This dispatcher script makes Wi-Fi mutually exclusive with wired + networking. When a wired interface is connected, Wi-Fi will be set + to airplane mode (rfkilled). When the wired interface is disconnected, + Wi-Fi will be turned back on. + Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ + directory. + See NetworkManager(8) + manual page for more information about NetworkManager dispatcher scripts. +

+

Example sessions of interactive connection editor

+
+

Example 12. Adding an ethernet connection profile in interactive editor (a)

+
+
+        
+$ nmcli connection edit type ethernet
+        
+
+
+
+===| nmcli interactive connection editor |===
+
+Adding a new '802-3-ethernet' connection
+
+Type 'help' or '?' for available commands.
+Type 'describe [<setting>.<prop>]' for detailed property description.
+
+You may edit the following settings: connection, 802-3-ethernet (ethernet), 802-1x, ipv4, ipv6, dcb
+nmcli> print
+===============================================================================
+                              Connection details
+===============================================================================
+connection.id:                          ethernet-4
+connection.uuid:                        de89cdeb-a3e1-4d53-8fa0-c22546c775f4
+connection.interface-name:              --
+connection.type:                        802-3-ethernet
+connection.autoconnect:                 yes
+connection.autoconnect-priority:        0
+connection.timestamp:                   0
+connection.read-only:                   no
+connection.permissions:                 
+connection.zone:                        --
+connection.master:                      --
+connection.slave-type:                  --
+connection.secondaries:                 
+connection.gateway-ping-timeout:        0
+-------------------------------------------------------------------------------
+802-3-ethernet.port:                    --
+802-3-ethernet.speed:                   0
+802-3-ethernet.duplex:                  --
+802-3-ethernet.auto-negotiate:          yes
+802-3-ethernet.mac-address:             --
+802-3-ethernet.cloned-mac-address:      --
+802-3-ethernet.mac-address-blacklist:   
+802-3-ethernet.mtu:                     auto
+802-3-ethernet.s390-subchannels:        
+802-3-ethernet.s390-nettype:            --
+802-3-ethernet.s390-options:            
+-------------------------------------------------------------------------------
+ipv4.method:                            auto
+ipv4.dns:                               
+ipv4.dns-search:                        
+ipv4.addresses:                         
+ipv4.gateway:                           --
+ipv4.routes:                            
+ipv4.route-metric:                      -1
+ipv4.ignore-auto-routes:                no
+ipv4.ignore-auto-dns:                   no
+ipv4.dhcp-client-id:                    --
+ipv4.dhcp-send-hostname:                yes
+ipv4.dhcp-hostname:                     --
+ipv4.never-default:                     no
+ipv4.may-fail:                          yes
+-------------------------------------------------------------------------------
+ipv6.method:                            auto
+ipv6.dns:                               
+ipv6.dns-search:                        
+ipv6.addresses:                         
+ipv6.gateway:                           --
+ipv6.routes:                            
+ipv6.route-metric:                      -1
+ipv6.ignore-auto-routes:                no
+ipv6.ignore-auto-dns:                   no
+ipv6.never-default:                     no
+ipv6.may-fail:                          yes
+ipv6.ip6-privacy:                       -1 (unknown)
+ipv6.dhcp-hostname:                     --
+-------------------------------------------------------------------------------
+nmcli> goto ethernet
+You may edit the following properties: port, speed, duplex, auto-negotiate, mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchannels, s390-nettype, s390-options
+nmcli 802-3-ethernet> set mtu 1492
+nmcli 802-3-ethernet> b
+nmcli> goto ipv4.addresses
+nmcli ipv4.addresses> desc
+
+=== [addresses] ===
+[NM property description]
+Array of IP addresses.
+
+[nmcli specific description]
+Enter a list of IPv4 addresses formatted as:
+  ip[/prefix], ip[/prefix],...
+Missing prefix is regarded as prefix of 32.
+
+Example: 192.168.1.5/24, 10.0.0.11/24
+
+nmcli ipv4.addresses> set 192.168.1.100/24
+Do you also want to set 'ipv4.method' to 'manual'? [yes]: yes
+nmcli ipv4.addresses>
+nmcli ipv4.addresses> print
+addresses: 192.168.1.100/24
+nmcli ipv4.addresses> back
+nmcli ipv4> b
+nmcli> set ipv4.gateway 192.168.1.1
+nmcli> verify
+Verify connection: OK
+nmcli> print
+===============================================================================
+                              Connection details
+===============================================================================
+connection.id:                          ethernet-4
+connection.uuid:                        de89cdeb-a3e1-4d53-8fa0-c22546c775f4
+connection.interface-name:              --
+connection.type:                        802-3-ethernet
+connection.autoconnect:                 yes
+connection.autoconnect-priority:        0
+connection.timestamp:                   0
+connection.read-only:                   no
+connection.permissions:                 
+connection.zone:                        --
+connection.master:                      --
+connection.slave-type:                  --
+connection.secondaries:                 
+connection.gateway-ping-timeout:        0
+-------------------------------------------------------------------------------
+802-3-ethernet.port:                    --
+802-3-ethernet.speed:                   0
+802-3-ethernet.duplex:                  --
+802-3-ethernet.auto-negotiate:          yes
+802-3-ethernet.mac-address:             --
+802-3-ethernet.cloned-mac-address:      --
+802-3-ethernet.mac-address-blacklist:   
+802-3-ethernet.mtu:                     1492
+802-3-ethernet.s390-subchannels:        
+802-3-ethernet.s390-nettype:            --
+802-3-ethernet.s390-options:            
+-------------------------------------------------------------------------------
+ipv4.method:                            manual
+ipv4.dns:                               
+ipv4.dns-search:                        
+ipv4.addresses:                         192.168.1.100/24
+ipv4.gateway:                           192.168.1.1
+ipv4.routes:                            
+ipv4.route-metric:                      -1
+ipv4.ignore-auto-routes:                no
+ipv4.ignore-auto-dns:                   no
+ipv4.dhcp-client-id:                    --
+ipv4.dhcp-send-hostname:                yes
+ipv4.dhcp-hostname:                     --
+ipv4.never-default:                     no
+ipv4.may-fail:                          yes
+-------------------------------------------------------------------------------
+ipv6.method:                            auto
+ipv6.dns:                               
+ipv6.dns-search:                        
+ipv6.addresses:                         
+ipv6.routes:                            
+ipv6.route-metric:                      -1
+ipv6.ignore-auto-routes:                no
+ipv6.ignore-auto-dns:                   no
+ipv6.never-default:                     no
+ipv6.may-fail:                          yes
+ipv6.ip6-privacy:                       -1 (unknown)
+ipv6.dhcp-hostname:                     --
+-------------------------------------------------------------------------------
+nmcli> set ipv4.dns 8.8.8.8 8.8.4.4
+nmcli> print
+===============================================================================
+                              Connection details
+===============================================================================
+connection.id:                          ethernet-4
+connection.uuid:                        de89cdeb-a3e1-4d53-8fa0-c22546c775f4
+connection.interface-name:              --
+connection.type:                        802-3-ethernet
+connection.autoconnect:                 yes
+connection.autoconnect-priority:        0
+connection.timestamp:                   0
+connection.read-only:                   no
+connection.permissions:                 
+connection.zone:                        --
+connection.master:                      --
+connection.slave-type:                  --
+connection.secondaries:                 
+connection.gateway-ping-timeout:        0
+-------------------------------------------------------------------------------
+802-3-ethernet.port:                    --
+802-3-ethernet.speed:                   0
+802-3-ethernet.duplex:                  --
+802-3-ethernet.auto-negotiate:          yes
+802-3-ethernet.mac-address:             --
+802-3-ethernet.cloned-mac-address:      --
+802-3-ethernet.mac-address-blacklist:   
+802-3-ethernet.mtu:                     1492
+802-3-ethernet.s390-subchannels:        
+802-3-ethernet.s390-nettype:            --
+802-3-ethernet.s390-options:            
+-------------------------------------------------------------------------------
+ipv4.method:                            manual
+ipv4.dns:                               8.8.8.8,8.8.4.4
+ipv4.dns-search:                        
+ipv4.addresses:                         192.168.1.100/24
+ipv4.gateway:                           192.168.1.1
+ipv4.routes:                            
+ipv4.route-metric:                      -1
+ipv4.ignore-auto-routes:                no
+ipv4.ignore-auto-dns:                   no
+ipv4.dhcp-client-id:                    --
+ipv4.dhcp-send-hostname:                yes
+ipv4.dhcp-hostname:                     --
+ipv4.never-default:                     no
+ipv4.may-fail:                          yes
+-------------------------------------------------------------------------------
+ipv6.method:                            auto
+ipv6.dns:                               
+ipv6.dns-search:                        
+ipv6.addresses:                         
+ipv6.gateway:                           --
+ipv6.routes:                            
+ipv6.route-metric:                      -1
+ipv6.ignore-auto-routes:                no
+ipv6.ignore-auto-dns:                   no
+ipv6.never-default:                     no
+ipv6.may-fail:                          yes
+ipv6.ip6-privacy:                       -1 (unknown)
+ipv6.dhcp-hostname:                     --
+-------------------------------------------------------------------------------
+nmcli> verify
+Verify connection: OK
+nmcli> save
+Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved.
+nmcli> quit
+
+
+
+

+ Example session in the nmcli interactive connection editor. + The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). +

+
+
+

See Also

+

+ nmcli(1), + NetworkManager(8), + NetworkManager.conf(5), + nm-settings(5), + nm-online(1), + nm-applet(1), + nm-connection-editor(1) +

+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/ref-dbus.html b/docs/api/html/ref-dbus.html deleted file mode 100644 index 8a0b56c7..00000000 --- a/docs/api/html/ref-dbus.html +++ /dev/null @@ -1,34 +0,0 @@ - - - - -D-Bus API Reference: NetworkManager D-Bus Reference Manual - - - - - - - - - - - - - - - - -
-

-D-Bus API Reference

-

- This part documents the D-Bus interface used to access the - NetworkManager daemon. -

-spec.html -
-
-
Generated by GTK-Doc V1.24
- - \ No newline at end of file diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html deleted file mode 100644 index 6527f738..00000000 --- a/docs/api/html/ref-migrating.html +++ /dev/null @@ -1,540 +0,0 @@ - - - - -Migrating from NetworkManager 0.8 to NetworkManager 0.9: NetworkManager D-Bus Reference Manual - - - - - - - - - - - - - - - - -
-

-Migrating from NetworkManager 0.8 to NetworkManager 0.9

-
-
Architecture and D-Bus API Changes in 0.9
-
-
Elimination of the User Settings Service
-
User Secret Agents
-
Settings Service Interface Changes
-
Connection Object Interface Changes
-
Permissions Methods Consolidation
-
AddConnection Returns Object Path of New Connection
-
Support for WiMAX Devices
-
New Device States
-
New Active Connection State
-
Consolidated Modem Devices
-
Secret Property Flags
-
Deprecated Methods Removed
-
-
-

- NetworkManager 0.9 is a new major version of NetworkManager that breaks - both API and ABI compared to previous versions. These changes are - intended to make communication with NetworkManager much simpler, especially - for network control and configuration programs. Thankfully, most changes - are not difficult to implement, and the advantages of the simpler - architecture of NetworkManager 0.9 greatly outweight the effort of - updating client programs. -

-
-

-Architecture and D-Bus API Changes in 0.9

-

- This section details the architectural and D-Bus API changes in - NetworkManager 0.9. -

-
-

-Elimination of the User Settings Service

-

- Previously there were two "settings services", or D-Bus services that - provided and saved network configuration information. NetworkManager - owned the "system" settings service, and one user-level applet owned the - "user" settings service. Now, the "user" settings service has been - eliminated, so clients only have to track one D-Bus service to read and - update network configuration. The functionality of the old user settings - service has been replaced with a "permissions" key on each connection - object to preserve the ability to restrict which users can use the - connection, and with a "secret agent" D-Bus API for user-session-level - secure storage of network secrets and passwords. -

-

- Elimination of the user settings service provides the following advantages - for clients of NetworkManager: -

-
    -
  • Simpler discovery of network configuration and change tracking
    • -
  • Simpler storage of user-level network secrets by control applets
    • -
  • Correct operation of fast-user switching and multi-seat configurations
    • -
  • More granular network connection permissions for system administrators
    • -
  • Connections are now system-wide by default (unless restricted by the user or system administrator)
    • -
  • Easier deployment of user-specific connections (ie, VPNs)
    • -
-

-

-

- With this change, D-Bus methods that previously took a "service name" - argument (like - org.freedesktop.NetworkManager.ActivateConnection) and - objects with service name properties (like ActiveConnection objects) no - longer have those arguments or properties. -

-

- Action: if you develop a network control - applet that talks to NetworkManager and used to provide a user settings - service, you can eliminate that code and rely on NetworkManager for all - storage of network configuration. Your applet should now implement the - Secret Agent D-Bus API (see below) to store user-specific secrets, and - add legacy user-specific configuration to NetworkManager when run. More - information about both these changes follows. -

-
-
-

-User Secret Agents

-

- Even with the elimination of the user settings service, in some cases it - is still desirable to store secrets in the user's session and not in - system-wide storage (and thus available to all users). To allow this - functionality the concept of agents has been introduced. Using the new - - org.freedesktop.NetworkManager.AgentManager - D-Bus interface provided by NetworkManager, user applications can register - themselves as "secret agents", ie programs capable of saving and providing - secrets to NetworkManager. The agent should export the - - org.freedesktop.NetworkManager.SecretAgent - D-Bus interface, but should NOT claim a bus name on the system or session - bus. Instead, NetworkManager talks to the agent directly over the D-Bus - connection which the agent used to register itself. -

-

- Each agent must send a unique identifier to NetworkManager when it - registers. This identifier must follow certain rules (see the NM D-Bus - API documentation for more details) but looks essentially the same as - a D-Bus service name. Only one agent using a given identifier may be - registered at the same time. The agent is automatically unregistered - if it disconnects from D-Bus or exits. -

-

- When NetworkManager requires secrets during the attempt to connect to a - network, and no secrets are available from the internal settings service, - NetworkManager queries each registered agent for secrets. Agents that - are in "active" user sessions (as determined by ConsoleKit) are preferred - over inactive ones. Only agents belonging to users who have permission - to view and modify the connection are queried. For more information on - connection permissions, see below. -

- When secrets are requested, the agent is also sent a set of flags that - modify the behavior of the request. By default, the agent should never - attempt to query the user for secrets, but should simply return any - available saved secrets. Other flags allow the agent to explicitly - request new secrets from the user. -

- Action: the parts of a previous user - settings service that handled secrets may be easily repurposed as the bulk - of the implementation of a secret agent. The agent is sent all available - connection settings, and from those should be able to retrieve or save - any saved user secrets, or to request new secrets from the user. -

-
-
-

-Settings Service Interface Changes

-

- With the elimination of the user settings service, the old - org.freedesktop.NetworkManagerUserSettings and - org.freedesktop.NetworkManagerSystemSettings D-Bus - service names are no longer used. Instead NetworkManager provides the - settings service using its own D-Bus service name, - org.freedesktop.NetworkManager. The object path of - the settings service has also changed to - /org/freedesktop/NetworkManager/Settings. -

-

- Additionally, the D-Bus interface of the settings service has changed - to - org.freedesktop.NetworkManager.Settings from - the old interface name of - org.freedesktop.NetworkManagerSettings, and the old - org.freedesktop.NetworkManagerSettings.System - interface has been merged into the new - - org.freedesktop.NetworkManager.Settings interface - as the split no longer made sense. This includes the - SaveHostname method and the Hostname - and CanModify properties. -

-

- Action: change the service name and - object path that your application uses to request system network settings - to org.freedesktop.NetworkManager and - /org/freedesktop/NetworkManager/Settings respectively, - and update the D-Bus interface that codes uses to talk to the settings - service to - org.freedesktop.NetworkManager.Settings. - Listen for hostname changes using the new interface name as well. -

-
-
-

-Connection Object Interface Changes

-

- Consistent with the interface changes to the Settings object, the - Connection object's D-Bus interface has changed to - - org.freedesktop.NetworkManager.Settings.Connection - from the previous - org.freedesktop.NetworkManagerSettings.Connection. -

-

- Additionally, the - org.freedesktop.NetworkManager.Settings.Connection.Updated - signal of the Connection object no longer includes the updated settings - data argument, as that might allow users who are not authorized to - view the connection details to do so. Instead, when a client receives the - Updated signal, it should requery the Connection's settings with the - org.freedesktop.NetworkManager.Settings.Connection.GetSettings - method. If the client receives an error as a result of this method call, - it should assume the connection has been deleted. -

-

- Action: where code manipulates - Connection objects, update the D-Bus interface that code uses to be - org.freedesktop.NetworkManager.Settings.Connection. - Additionally, code that listens for the - org.freedesktop.NetworkManager.Settings.Connection.Updated - signal should no longer expect the new settings data as an argument, but - instead should request the new settings data using the - org.freedesktop.NetworkManager.Settings.Connection.GetSettings - method. -

-
-
-

-Permissions Methods Consolidation

-

- Previously there were two D-Bus method calls to retrieve the list of - operations that a user client could perform, and two signals notifying - callers that they should recheck permissions. Those two calls were: -

-
    -
  • -org.freedesktop.NetworkManagerSettings.System.GetPermissions - which returned a bitfield of operations the caller was allowed to - perform related to modify system network settings and the machine - hostname -
    • -
  • -org.freedesktop.NetworkManager.GetPermissions which - returned a dictionary mapping permission names to result strings like - "yes", "auth", or "no", relating to network control permissions like - the ability to enable or disable WiFi. -
    • -
-

- These two calls have been consolidated into an enhanced - org.freedesktop.NetworkManager.GetPermissions call that - uses the same arguments, but includes all permissions, including those which - the settings service used to handle. -

-

- With this change, the bitfield items from - org.freedesktop.NetworkManagerSettings.System.GetPermissions - are now string-based permissions. The mapping is as follows: -

-
-

Table 31. 

-
---- - - - - - - - - - - - - - - - - - - - - - - -
Old bitfield valueNew permission name
0x1 (connection-modify)
 - org.freedesktop.NetworkManager.settings.modify.system - or org.freedesktop.NetworkManager.settings.modify.system - depending on the permissions of the connection. - 
0x2 (wifi-share-protected)
 - org.freedesktop.NetworkManager.wifi.share.protected - 
0x4 (wifi-share-open)
 - org.freedesktop.NetworkManager.wifi.share.open - 
0x8 (hostname-modify)
 - org.freedesktop.NetworkManager.settings.modify.hostname -
-
-


-

-

- Action: modify handling of existing - code that checks permissions to recognize the new permissions names for - old system settings permissions, and remove code that used to call - org.freedesktop.NetworkManagerSettings.System.GetPermissions. -

-
-
-

-AddConnection Returns Object Path of New Connection

-

- The - org.freedesktop.NetworkManager.Settings.AddConnection - method call now returns the object path of the newly added - connection. Previously, if code wanted to manipulate a connection - post-addition, it had to wait for the new connection to be announced via - the NewConnection signal by matching connection UUIDs. Now the object - path is returned and this workaround is no longer required. -

-

- Action: update code that adds new - connections to handle the object path returned from AddConnection, and - remove workarounds for finding the new connection via signals. -

-
-
-

-Support for WiMAX Devices

-

- NetworkManager now supports Intel WiMAX mobile broadband devices. A - corresponding device type (NM_DEVICE_TYPE_WIMAX) and - a new - org.freedesktop.NetworkManager.Device.WiMax - D-Bus interface have been added. Furthermore, to support connection to - different WiMAX Network Service Providers (NSPs) the - - org.freedesktop.NetworkManager.Device.WiMax.Nsp - interface has been added to access information about each available - WiMAX network. -

-

- Action: update code that handles - devices and/or displays status to users to recognize the new device type, - and to display available WiMAX NSPs similar to how WiFi Access Points - are displayed. Also update code that creates new connections to allow - creation of new WiMAX connections. -

-
-
-

-New Device States

-

- A few new device states - have been added, and all device states have been renumbered for flexibility. - The new devices states IP_CHECK, SECONDARIES, and DEACTIVATING. -

-

- Action: where code checks device state - or shows UI indication of the device's state, make sure the new device - states are processed correctly, and that code in switch()-type statements - is updated to handle the new states. -

-
-
-

-New Active Connection State

-

- Along with the new device states, an - additional - ActiveConnection state has been added: DEACTIVATING. This state - is entered when the connection is being torn down and deactivated. -

-

- Action: where code checks active - connection states or shows UI indication of active connection states, make - sure the DEACTIVATING state is processed correctly, and that code in - switch()-type statements is updated to handle it. -

-
-
-

-Consolidated Modem Devices

-

- Many new mobile broadband devices support multiple access families, like - Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE - or UMTS/LTE modems like the Pantech UML290. The previous hard split - between CDMA/EVDO and GSM/UMTS device classes was not flexible enough to - deal with these new multi-mode devices. Thus the previously separate - CDMA and GSM device classes have been combined into a single Modem - device class, which exposes both hardware "ModemCapabilities" and - runtime "CurrentCapabilities" which represent generic access technology - families like CDMA/EVDO, GSM/UMTS, and LTE which the device supports. - ModemCapabilities indicate all the access technology families which the - modem is capable of supporting, while CurrentCapabilities indicate the - immediate access technology families the device supports without reloading - the firmware and thus restarting the device. -

-

- Along with this change, the - org.freedesktop.NetworkManager.Device.Serial - interface has been removed as it's functionality will be incorporated - into the - - org.freedesktop.NetworkManager.Device.Modem - interface in the future. -

-

- Action: combine code that checks for - the old CDMA and GSM device types, and instead handle the new Modem device - type. Where behavior must change based on the capabilities of the device, - check the CurrentCapabilities device property to determine whether to - treat the device as CDMA, GSM, or LTE for purposes of configuration and - status. -

-
-
-

-Secret Property Flags

-

- In the Connection object's configuration properties, each setting's secret - properties (like WiFi passphrases, or public key passwords, etc) now has - an associated "flags" property that changes how NetworkManager treats the - secret. The "flags" property is a bitfield of one or more of the - following values: -

-
-

Table 32. 

-
---- - - - - - - - - - - - - - - - - - - - - - - -
Flag ValueMeaning
0x00 (none)
 - NetworkManager is responsible for providing and storing this - secret (default) - 
0x01 (agent-owned)
 - A user secret agent is responsible for providing and storing - this secret; when it is required agents will be asked to - retrieve it - 
0x02 (not saved)
 - The secret is not saved, and should be requested each time it - is required. Used for OTP/token configurations where the - secret changes periodically, or if the user simply wants to - manually enter the secret each time. - 
0x04 (not required)
 - In situations where it cannot be automatically determined that - the secret is required (some VPNs and PPP providers dont require - all possible secrets) this flag indicates that the specific - secret is not required. -
-
-


-

-

- Action: user interface code which - handles entry of connection secrets should be updated to read and set - secret flags. For example, code that creates new VPN connections may want - to set the "agent-owned" flag to ensure that the user's VPN password is - not available to all users. EAP-TLS and VPN interface code might add a - checkbox that toggles the "not saved" bit to indicate that the - password/PIN code should be requested from a hardware token each time it - is required. -

-
-
-

-Deprecated Methods Removed

-

- A few methods and signals of the org.freedesktop.NetworkManager - interface deprecated in version 0.7 have been removed. All the - replacement methods and signals have existed since version 0.7 and so are - not new to this version of NetworkManager, but some older programs may - be using removed items. The following table lists the removed items and - their replacements: -

-
-

Table 33. 

-
---- - - - - - - - - - - - - - - -
Removed ItemReplacement
StateChange signal
 - Use the StateChanged signal, which has the - same arguments. - 
sleep() and wake() methods
 - Use the Sleep() method instead, which takes - a boolean argument indicating whether NetworkManager should - go to sleep or wake up. -
-
-


-

-

- Action: update code to use these - replacement methods and properties where it used old deprecated ones -

-
-
-
-
-
Generated by GTK-Doc V1.24
- - \ No newline at end of file diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index 5bf9720a..e8de233c 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -2,11 +2,11 @@ -Network Configuration Setting Specification: NetworkManager D-Bus Reference Manual +Network Configuration Setting Specification: NetworkManager D-Bus API Reference Manual - - - + + + @@ -16,7 +16,7 @@ Home -Prev +Prev Next
@@ -83,6 +83,12 @@ Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. +
domain-suffix-match
+
string
+

+Constraint 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.
+
+
 
eap

 
array of string

 
[]

@@ -185,6 +191,12 @@
 Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
 
 
+
phase2-domain-suffix-match

+
string

+

+Constraint 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 during the inner "phase 2" authentication.  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.
+
+
 
phase2-private-key

 
byte array

 

@@ -206,7 +218,7 @@
 
phase2-subject-match

 
string

 

-Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed.
+Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed.  This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.
 
 
 
pin

@@ -242,7 +254,7 @@
 
subject-match

 
string

 

-Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.
+Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.  This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.
 
 
 
system-ca-certs

@@ -1104,7 +1116,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.
+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.
 
 
 
name

@@ -1250,7 +1262,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.
+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.
 
 
 
name

diff --git a/docs/api/html/secrets-flags.html b/docs/api/html/secrets-flags.html
index bb727419..89e2ca77 100644
--- a/docs/api/html/secrets-flags.html
+++ b/docs/api/html/secrets-flags.html
@@ -2,12 +2,12 @@
 
 
 
-Secret flag types: NetworkManager D-Bus Reference Manual
+Secret flag types: NetworkManager D-Bus API Reference Manual
 
-
+
 
 
-
+
 
 
 
@@ -17,7 +17,7 @@
 Home
 Up
 Prev
-Next
+Next
 
 

 

diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html
index 990fd2ba..45b98a21 100644
--- a/docs/api/html/spec.html
+++ b/docs/api/html/spec.html
@@ -1,2792 +1,139 @@
-NetworkManager D-Bus Interface Specification version 1.1.91
NetworkManager D-Bus Interface Specification
Version 1.1.91
Copyright (C) 2008 - 2016 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.

-
This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.

-
-
This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-General Public License for more details.

-
-
You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

-
Interfaces

-  
org.freedesktop.NetworkManager
Methods:
GetDevices (
-        
-        ) →
-        ao

-        Get the list of realized network devices.
-      
Returns
devices -
-      ao

-          List of object paths of network devices known to the system.  This
-          list does not include device placeholders (see GetAllDevices()).
-        
GetAllDevices (
-        
-        ) →
-        ao

-        Get the list of all network devices.
-      
Returns
devices -
-      ao

-          List of object paths of network devices and device placeholders
-          (eg, devices that do not yet exist but which can be automatically
-          created by NetworkManager if one of their AvailableConnections
-          was activated).
-        
GetDeviceByIpIface (
-        s: iface
-        ) →
-        o

-        Return the object path of the network device referenced by its IP
-        interface name.  Note that some devices (usually modems) only have an
-        IP interface name when they are connected.
-      
Parameters
iface -
-      s

-          Interface name of the device to find.
-        
Returns
device -
-      o

-          Object path of the network device.
-        
ActivateConnection (
-        o: connection, o: device, o: specific_object
-        ) →
-        o

-        Activate a connection using the supplied device.
-      
Parameters
connection -
-      o

-          The connection to activate.  If "/" is given, a valid device path must
-          be given, and NetworkManager picks the best connection to activate for
-          the given device.  VPN connections must always pass a valid connection
-          path.
-        
device -
-      o

-          The object path of device to be activated for physical connections.
-          This parameter is ignored for VPN connections, because the
-          specific_object (if provided) specifies the device to use.
-        
specific_object -
-      o

-          The path of a connection-type-specific object this activation should use. 
-          This parameter is currently ignored for wired and mobile broadband connections,
-          and the value of "/" should be used (ie, no specific object).  For WiFi
-          connections, pass the object path of a specific AP from the card's scan
-          list, or "/" to pick an AP automatically.  For VPN connections, pass
-          the object path of an ActiveConnection object that should serve as the
-          "base" connection (to which the VPN connections lifetime will be tied),
-          or pass "/" and NM will automatically use the current default device.
-        
Returns
active_connection -
-      o

-          The path of the active connection object representing this active connection.
-        
AddAndActivateConnection (
-        a{sa{sv}}: connection, o: device, o: specific_object
-        ) →
-        o, o

-        Adds a new connection using the given details (if any) as a template
-        (automatically filling in missing settings with the capabilities of the
-        given device and specific object), then activate the new connection.
-        Cannot be used for VPN connections at this time.
-      
Parameters
connection -
-      a{sa{sv}}

-          Connection settings and properties; if incomplete missing settings will
-          be automatically completed using the given device and specific object.
-        
device -
-      o

-          The object path of device to be activated using the given connection.
-        
specific_object -
-      o

-          The path of a connection-type-specific object this activation should use. 
-          This parameter is currently ignored for wired and mobile broadband connections,
-          and the value of "/" should be used (ie, no specific object).  For WiFi
-          connections, pass the object path of a specific AP from the card's scan
-          list, which will be used to complete the details of the newly added
-          connection.
-        
Returns
path -
-      o

-          Object path of the new connection that was just added.
-        
active_connection -
-      o

-          The path of the active connection object representing this active connection.
-        
DeactivateConnection (
-        o: active_connection
-        ) →
-        nothing

-        Deactivate an active connection.
-      
Parameters
active_connection -
-      o

-          The currently active connection to deactivate.
-        
Sleep (
-        b: sleep
-        ) →
-        nothing

-        Control the NetworkManager daemon's sleep state.  When asleep, all
-        interfaces that it manages are deactivated.  When awake, devices are
-        available to be activated.  This command should not be called directly
-        by users or clients; it is intended for system suspend/resume tracking.
-      
Parameters
sleep -
-      b

-          Indicates whether the NetworkManager daemon should sleep or wake.
-        
Enable (
-        b: enable
-        ) →
-        nothing

-        Control whether overall networking is enabled or disabled.  When
-        disabled, all interfaces that NM manages are deactivated.  When enabled,
-        all managed interfaces are re-enabled and available to be activated.
-        This command should be used by clients that provide to users the ability
-        to enable/disable all networking.
-      
Parameters
enable -
-      b

-          If FALSE, indicates that all networking should be disabled.  If TRUE,
-          indicates that NetworkManager should begin managing network devices.
-        
GetPermissions (
-        
-        ) →
-        a{ss}

-        Returns the permissions a caller has for various authenticated operations
-        that NetworkManager provides, like Enable/Disable networking, changing
-        WiFi, WWAN, and WiMAX state, etc.
-      
Returns
permissions -
-      a{ss}

-          Dictionary of available permissions and results.  Each permission
-          is represented by a name (ie "org.freedesktop.NetworkManager.Foobar")
-          and each result is one of the following values: "yes" (the permission
-          is available), "auth" (the permission is available after a successful
-          authentication), or "no" (the permission is denied).  Clients may use
-          these values in the UI to indicate the ability to perform certain
-          operations.
-        
SetLogging (
-        s: level, s: domains
-        ) →
-        nothing

-        Set logging verbosity and which operations are logged.
-      
Parameters
level -
-      s

-          One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP].
-          This level is applied to the domains as specified in the domains
-          argument. Except for the special level "KEEP", all unmentioned
-          domains are disabled entirely. "KEEP" is special and allows
-          not to change the current setting except for the specified
-          domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only
-          touch the platform domain.
-        
domains -
-      s

-          A combination of logging domains separated by commas (','), or "NONE"
-          to disable logging.  Each domain enables logging for operations
-          related to that domain.  Available domains are: [PLATFORM, RFKILL, ETHER,
-          WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS,
-          VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE,
-          OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS,
-          TEAM, CONCHECK, DCB, DISPATCH, AUDIT].
-          In addition to these domains, the following special domains can be used:
-          [NONE, ALL, DEFAULT, DHCP, IP].  You can also specify that some domains
-          should log at a different level from the default by appending a colon (':')
-          and a log level (eg, 'WIFI:DEBUG').  If an empty string is given, the
-          log level is changed but the current set of log domains remains
-          unchanged.
-        
GetLogging (
-        
-        ) →
-        s, s

-        Get current logging verbosity level and operations domains.
-      
Returns
level -
-      s

-          One of [ERR, WARN, INFO, DEBUG, TRACE].
-        
domains -
-      s

-          For available domains see SetLogging() call.
-        
CheckConnectivity (
-        
-        ) →
-        u

-	Re-check the network connectivity state.
-      
Returns
connectivity -
-      u
-      (NM_CONNECTIVITY)
-    

-          The current connectivity state.
-        
state (
-        
-        ) →
-        u

-        The overall networking state as determined by the NetworkManager daemon,
-        based on the state of network devices under it's management.
-      
Returns
state -
-      u
-      (NM_STATE)
-    
Signals:
CheckPermissions (
-        
-        )

-        Emitted when system authorization details change, indicating that
-        clients may wish to recheck permissions with GetPermissions.
-      
StateChanged (
-        u: state
-        )

-        NetworkManager's state changed.
-      
Parameters
state -
-      u
-      (NM_STATE)
-    

-          The new state of NetworkManager.
-        
PropertiesChanged (
-        a{sv}: properties
-        )

-        NetworkManager's properties changed.
-      
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-          The changed properties.
-        
DeviceAdded (
-        o: device_path
-        )

-        A device was added to the system
-      
Parameters
device_path -
-      o

-          The object path of the newly added device.
-        
DeviceRemoved (
-        o: device_path
-        )

-        A device was removed from the system, and is no longer available.
-      
Parameters
device_path -
-      o

-          The object path of the device that was just removed.
-        
Properties:
Devices -
-      ao -
-      (read)

-        The list of realized network devices. Realized devices are those which
-        have backing resources (eg from the kernel or a management daemon like
-        ModemManager, teamd, etc).
-      
AllDevices -
-      ao -
-      (read)

-        The list of both realized and un-realized network devices. Un-realized
-        devices are software devices which do not yet have backing resources,
-        but for which backing resources can be created if the device is
-        activated.
-      
NetworkingEnabled -
-      b -
-      (read)

-        Indicates if overall networking is currently enabled or not.  See the
-        Enable() method.
-      
WirelessEnabled -
-      b -
-      (readwrite)

-        Indicates if wireless is currently enabled or not.
-      
WirelessHardwareEnabled -
-      b -
-      (read)

-        Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
-      
WwanEnabled -
-      b -
-      (readwrite)

-        Indicates if mobile broadband devices are currently enabled or not.
-      
WwanHardwareEnabled -
-      b -
-      (read)

-        Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.
-      
WimaxEnabled -
-      b -
-      (readwrite)

-        Indicates if WiMAX devices are currently enabled or not.
-      
WimaxHardwareEnabled -
-      b -
-      (read)

-        Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.
-      
ActiveConnections -
-      ao -
-      (read)

-        List of active connection object paths.
-      
PrimaryConnection -
-      o -
-      (read)

-        The object path of the "primary" active connection being used
-        to access the network. In particular, if there is no VPN
-        active, or the VPN does not have the default route, then this
-        indicates the connection that has the default route. If there
-        is a VPN active with the default route, then this indicates
-        the connection that contains the route to the VPN endpoint.
-      
PrimaryConnectionType -
-      s -
-      (read)

-        The connection type of the "primary" active connection being
-        used to access the network. This is the same as the Type
-        property on the object indicated by PrimaryConnection.
-      
Metered -
-      u -
-      (read)
-      (NM_METERED)
-    

-        Indicates whether the connectivity is metered. This is equivalent
-        to the metered property of the device associated with the primary
-        connection.
-      
ActivatingConnection -
-      o -
-      (read)

-        The object path of an active connection that is currently
-        being activated and which is expected to become the new
-        PrimaryConnection when it finishes activating.
-      
Startup -
-      b -
-      (read)

-        Indicates whether NM is still starting up; this becomes FALSE
-        when NM has finished attempting to activate every connection
-        that it might be able to activate at startup.
-      
Version -
-      s -
-      (read)

-        NetworkManager version.
-      
State -
-      u -
-      (read)
-      (NM_STATE)
-    

-        The overall state of the NetworkManager daemon.
-      
Connectivity -
-      u -
-      (read)
-      (NM_CONNECTIVITY)
-    

-        The network connectivity state.
-      
GlobalDnsConfiguration -
-      a{sv} -
-      (readwrite)

-        Dictionary of global DNS settings where the key is one of
-        "searches", "options" and "domains".  The values for the
-        "searches" and "options" keys are string arrays describing the
-        list of search domains and resolver options, respectively.
-        The value of the "domains" key is a second-level dictionary,
-        where each key is a domain name, and each key's value is a
-        third-level dictionary with the keys "servers" and
-        "options". "servers" is a string array of DNS servers,
-        "options" is a string array of domain-specific options.
-      
Enumerated types:
NM_STATE

-        Describes the overall state of the daemon.
-      
NM_STATE_UNKNOWN = 0

-          Networking state is unknown.
-        
NM_STATE_ASLEEP = 10

-          Networking is inactive and all devices are disabled.
-        
NM_STATE_DISCONNECTED = 20

-          There is no active network connection.
-        
NM_STATE_DISCONNECTING = 30

-          Network connections are being cleaned up.
-        
NM_STATE_CONNECTING = 40

-          A network device is connecting to a network and there is no other
-          available network connection.
-        
NM_STATE_CONNECTED_LOCAL = 50

-          A network device is connected, but there is only link-local connectivity.
-        
NM_STATE_CONNECTED_SITE = 60

-          A network device is connected, but there is only site-local connectivity.
-        
NM_STATE_CONNECTED_GLOBAL = 70

-          A network device is connected, with global network connectivity.
-        
NM_CONNECTIVITY

-        Describes the network-connectivity state.
-      
NM_CONNECTIVITY_UNKNOWN = 0

-          Network connectivity is unknown.
-        
NM_CONNECTIVITY_NONE = 1

-          The host is not connected to any network.
-        
NM_CONNECTIVITY_PORTAL = 2

-          The host is behind a captive portal and cannot reach the
-          full Internet.
-        
NM_CONNECTIVITY_LIMITED = 3

-          The host is connected to a network, but does not appear to
-	  be able to reach the full Internet.
-        
NM_CONNECTIVITY_FULL = 4

-	  The host is connected to a network, and appears to be able
-	  to reach the full Internet
-        

-
-  
org.freedesktop.NetworkManager.AccessPoint
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Flags -
-      u -
-      (read)
-      (NM_802_11_AP_FLAGS)
-    
Flags describing the capabilities of the access point.
WpaFlags -
-      u -
-      (read)
-      (NM_802_11_AP_SEC)
-    
Flags describing the access point's capabilities according to WPA (Wifi Protected Access).
RsnFlags -
-      u -
-      (read)
-      (NM_802_11_AP_SEC)
-    
Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.
Ssid -
-      ay -
-      (read)
The Service Set Identifier identifying the access point.
Frequency -
-      u -
-      (read)
The radio channel frequency in use by the access point, in MHz.
HwAddress -
-      s -
-      (read)
The hardware address (BSSID) of the access point.
Mode -
-      u -
-      (read)
-      (NM_802_11_MODE)
-    
Describes the operating mode of the access point.
MaxBitrate -
-      u -
-      (read)
The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).
Strength -
-      y -
-      (read)
The current signal quality of the access point, in percent.
LastSeen -
-      i -
-      (read)

-        The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access
-        point was found in scan results.  A value of -1 means the access point
-        has never been found in scan results.
-      
Sets of flags:
NM_802_11_AP_FLAGS

-        Flags describing the general capabilities of the access point.
-      
NM_802_11_AP_FLAGS_NONE = 0x0
Null capability - says nothing about the access point.
NM_802_11_AP_FLAGS_PRIVACY = 0x1
Access point supports privacy measures.
NM_802_11_AP_SEC

-        Flags describing the security capabilities of the access point.
-      
NM_802_11_AP_SEC_NONE = 0x0
Null flag.
NM_802_11_AP_SEC_PAIR_WEP40 = 0x1
Access point supports pairwise 40-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_WEP104 = 0x2
Access point supports pairwise 104-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_TKIP = 0x4
Access point supports pairwise TKIP encryption.
NM_802_11_AP_SEC_PAIR_CCMP = 0x8
Access point supports pairwise CCMP encryption.
NM_802_11_AP_SEC_GROUP_WEP40 = 0x10
Access point supports a group 40-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_WEP104 = 0x20
Access point supports a group 104-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_TKIP = 0x40
Access point supports a group TKIP cipher.
NM_802_11_AP_SEC_GROUP_CCMP = 0x80
Access point supports a group CCMP cipher.
NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100
Access point supports PSK key management.
NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200
Access point supports 802.1x key management.

-
-  
org.freedesktop.NetworkManager.Device
Methods:
Reapply (
-        a{sa{sv}}: connection, t: version_id, u: flags
-        ) →
-        nothing

-        Attempts to update the configuration of a device without deactivating it. NetworkManager
-        has the concept of connections, which are profiles that contain the configuration for
-        a networking device. Those connections are exposed via D-Bus as individual objects
-        that can be created, modified and deleted. When activating such a settings-connection
-        on a device, the settings-connection is cloned to become an applied-connection and used to
-        configure the device (see GetAppliedConnection). Subsequent modification of the
-        settings-connection don't propagate automatically to the device's applied-connection
-        (with exception of the firewall-zone and the metered property). For the changes to take
-        effect, you can either re-activate the settings-connection, or call Reapply.
-        The Reapply call allows you to directly update the applied-connection and reconfigure
-        the device.
-        Reapply can also be useful if the currently applied-connection is equal to the connection
-        that is about to be reapplied. This allows to reconfigure the device and revert external
-        changes like removing or adding an IP address (which NetworkManager doesn't revert
-        automatically because it is assumed that the user made these changes intentionally outside
-        of NetworkManager).
-        Reapply can make the applied-connection different from the settings-connection,
-        just like updating the settings-connection can make them different.
-      
Parameters
connection -
-      a{sa{sv}}

-          The optional connection settings that will be reapplied on the device. If empty, the
-          currently active settings-connection will be used. The connection cannot arbitrarly
-          differ from the current applied-connection otherwise the call will fail.
-          Only certain changes are supported, like adding or removing IP addresses.
-        
version_id -
-      t

-          If non-zero, the current version id of the applied-connection must match.
-          The current version id can be retrieved via GetAppliedConnection.
-          This optional argument allows to catch concurrent modifications between
-          the GetAppliedConnection call and Reapply.
-        
flags -
-      u

-          Flags which would modify the behavior of the Reapply call.
-          There are no flags defined currently and the users should use the value of 0.
-        
GetAppliedConnection (
-        u: flags
-        ) →
-        a{sa{sv}}, t

-        Get the currently applied connection on the device. This is a snapshot of the last activated
-        connection on the device, that is the configuration that is currently applied on the device.
-        Usually this is the same as GetSettings of the referenced settings connection. However, it
-        can differ if the settings connection was subsequently modified or the applied connection was
-        modified by Reapply. The applied connection is set when activating a device or when calling
-        Reapply.
-      
Parameters
flags -
-      u

-          Flags which would modify the behavior of the GetAppliedConnection call.
-          There are no flags defined currently and the users should use the value of 0.
-        
Returns
connection -
-      a{sa{sv}}

-            The effective connection settings that the connection has currently applied.
-        
version_id -
-      t

-            The version-id of the currently applied connection. This can be specified during
-            Reapply to avoid races where you first fetch the applied connection, modify it
-            and try to reapply it. If the applied connection is modified in the meantime, the
-            version_id gets incremented and Reapply will fail.
-        
Disconnect (
-        
-        ) →
-        nothing

-        Disconnects a device and prevents the device from automatically activating further connections without user intervention.
-      
Delete (
-        
-        ) →
-        nothing

-        Deletes a software device from NetworkManager and removes the interface from the system.
-        The method returns an error when called for a hardware device.
-      
Signals:
StateChanged (
-        u: new_state, u: old_state, u: reason
-        )
Parameters
new_state -
-      u
-      (NM_DEVICE_STATE)
-    

-          The new state of the device.
-        
old_state -
-      u
-      (NM_DEVICE_STATE)
-    

-          The previous state of the device.
-        
reason -
-      u
-      (NM_DEVICE_STATE_REASON)
-    

-          A reason for the state transition.
-        
Properties:
Udi -
-      s -
-      (read)

-        Operating-system specific transient device hardware identifier.  This
-        is an opaque string representing the underlying hardware for the device,
-        and shouldn't be used to keep track of individual devices.  For some
-        device types (Bluetooth, Modems) it is an identifier used by the
-        hardware service (ie bluez or ModemManager) to refer to that device,
-        and client programs use it get additional information from those
-        services which NM does not provide.  The Udi is not guaranteed to be
-        consistent across reboots or hotplugs of the hardware. If you're looking
-        for a way to uniquely track each device in your application, use the
-        object path.  If you're looking for a way to track a specific piece of
-        hardware across reboot or hotplug, use a MAC address or USB serial
-        number.
-      
Interface -
-      s -
-      (read)

-        The name of the device's control (and often data) interface.
-      
IpInterface -
-      s -
-      (read)

-        The name of the device's data interface when available.  This property
-        may not refer to the actual data interface until the device has
-        successfully established a data connection, indicated by the device's
-        State becoming ACTIVATED.
-      
Driver -
-      s -
-      (read)

-        The driver handling the device.
-      
DriverVersion -
-      s -
-      (read)

-        The version of the driver handling the device.
-      
FirmwareVersion -
-      s -
-      (read)

-        The firmware version for the device.
-      
Capabilities -
-      u -
-      (read)
-      (NM_DEVICE_CAP)
-    

-        Flags describing the capabilities of the device.
-      
Ip4Address -
-      u -
-      (read)

-        DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.
-      
State -
-      u -
-      (read)
-      (NM_DEVICE_STATE)
-    

-        The current state of the device.
-      
StateReason -
-      (uu) -
-      (read)
-      (NM_DEVICE_STATE_REASON_STRUCT)
-    

-        The current state and reason for changing to that state.
-      
ActiveConnection -
-      o -
-      (read)

-        Object path of an ActiveConnection object that "owns" this device during
-        activation.  The ActiveConnection object tracks the life-cycle of a
-        connection to a specific network and implements the
-        org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
-      
Ip4Config -
-      o -
-      (read)

-        Object path of the Ip4Config object describing the configuration of the device.  Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
-      
Dhcp4Config -
-      o -
-      (read)

-        Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server.  Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
-      
Ip6Config -
-      o -
-      (read)

-        Object path of the Ip6Config object describing the configuration of the device.  Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
-      
Dhcp6Config -
-      o -
-      (read)

-        Object path of the Dhcp6Config object describing the DHCP options
-        returned by the DHCP server.  Only valid when the device is in the
-        NM_DEVICE_STATE_ACTIVATED state.
-      
Managed -
-      b -
-      (readwrite)

-        Whether or not this device is managed by NetworkManager. Setting this
-        property has a similar effect to configuring the device as unmanaged
-        via the keyfile.unmanaged-devices setting in NetworkManager.conf.
-        Changes to this value are not persistent and lost after NetworkManager
-        restart.
-      
Autoconnect -
-      b -
-      (readwrite)

-        If TRUE, indicates the device is allowed to autoconnect.  If FALSE,
-        manual intervention is required before the device will automatically
-        connect to a known network, such as activating a connection using the
-        device, or setting this property to TRUE.  This property cannot be
-        set to TRUE for default-unmanaged devices, since they never autoconnect.
-      
FirmwareMissing -
-      b -
-      (read)

-        If TRUE, indicates the device is likely missing firmware necessary for
-        its operation.
-      
NmPluginMissing -
-      b -
-      (read)

-        If TRUE, indicates the NetworkManager plugin for the device is likely
-        missing or misconfigured.
-      
DeviceType -
-      u -
-      (read)
-      (NM_DEVICE_TYPE)
-    

-        The general type of the network device; ie Ethernet, WiFi, etc.
-      
AvailableConnections -
-      ao -
-      (read)

-        An array of object paths of every configured connection that is currently 'available' through this device.
-      
PhysicalPortId -
-      s -
-      (read)

-        If non-empty, an (opaque) indicator of the physical network
-        port associated with the device. This can be used to recognize
-	when two seemingly-separate hardware devices are actually just
-	different virtual interfaces to the same physical port.
-      
Mtu -
-      u -
-      (read)

-        The device MTU (maximum transmission unit).
-      
Metered -
-      u -
-      (read)
-      (NM_METERED)
-    

-        Whether the amount of traffic flowing through the device is
-        subject to limitations, for example set by service providers.
-      
LldpNeighbors -
-      aa{sv} -
-      (read)

-        Array of LLDP neighbors; each element is a dictionary mapping
-        LLDP TLV names to variant boxed values.
-      
Real -
-      b -
-      (read)

-        True if the device exists, or False for placeholder devices that
-        do not yet exist but could be automatically created by NetworkManager
-        if one of their AvailableConnections was activated.
-      
Enumerated types:
NM_DEVICE_STATE
NM_DEVICE_STATE_UNKNOWN = 0

-          The device is in an unknown state.
-        
NM_DEVICE_STATE_UNMANAGED = 10

-          The device is recognized but not managed by NetworkManager.
-        
NM_DEVICE_STATE_UNAVAILABLE = 20

-          The device cannot be used (carrier off, rfkill, etc).
-        
NM_DEVICE_STATE_DISCONNECTED = 30

-          The device is not connected.
-        
NM_DEVICE_STATE_PREPARE = 40

-          The device is preparing to connect.
-        
NM_DEVICE_STATE_CONFIG = 50

-          The device is being configured.
-        
NM_DEVICE_STATE_NEED_AUTH = 60

-          The device is awaiting secrets necessary to continue connection.
-        
NM_DEVICE_STATE_IP_CONFIG = 70

-          The IP settings of the device are being requested and configured.
-        
NM_DEVICE_STATE_IP_CHECK = 80

-          The device's IP connectivity ability is being determined.
-        
NM_DEVICE_STATE_SECONDARIES = 90

-          The device is waiting for secondary connections to be activated.
-        
NM_DEVICE_STATE_ACTIVATED = 100

-          The device is active.
-        
NM_DEVICE_STATE_DEACTIVATING = 110

-          The device's network connection is being torn down.
-        
NM_DEVICE_STATE_FAILED = 120

-          The device is in a failure state following an attempt to activate it.
-        
NM_DEVICE_TYPE
NM_DEVICE_TYPE_UNKNOWN = 0

-          The device type is unknown.
-        
NM_DEVICE_TYPE_ETHERNET = 1

-          The device is wired Ethernet device.
-        
NM_DEVICE_TYPE_WIFI = 2

-          The device is an 802.11 WiFi device.
-        
NM_DEVICE_TYPE_UNUSED1 = 3
Unused
NM_DEVICE_TYPE_UNUSED2 = 4
Unused
NM_DEVICE_TYPE_BT = 5

-          The device is Bluetooth device that provides PAN or DUN capabilities.
-        
NM_DEVICE_TYPE_OLPC_MESH = 6

-          The device is an OLPC mesh networking device.
-        
NM_DEVICE_TYPE_WIMAX = 7

-          The device is an 802.16e Mobile WiMAX device.
-        
NM_DEVICE_TYPE_MODEM = 8

-          The device is a modem supporting one or more of analog telephone,
-          CDMA/EVDO, GSM/UMTS/HSPA, or LTE standards to access a cellular or
-          wireline data network.
-        
NM_DEVICE_TYPE_INFINIBAND = 9

-          The device is an IP-capable InfiniBand interface.
-        
NM_DEVICE_TYPE_BOND = 10

-          The device is a bond master interface.
-        
NM_DEVICE_TYPE_VLAN = 11

-          The device is a VLAN interface.
-        
NM_DEVICE_TYPE_ADSL = 12

-          The device is an ADSL device supporting PPPoE and PPPoATM protocols.
-        
NM_DEVICE_TYPE_BRIDGE = 13

-          The device is a bridge interface.
-        
NM_DEVICE_TYPE_GENERIC = 14

-          The device is a generic interface type unrecognized by NetworkManager.
-        
NM_DEVICE_TYPE_TEAM = 15

-          The device is a team master interface.
-        
NM_DEVICE_STATE_REASON
NM_DEVICE_STATE_REASON_UNKNOWN = 0

-          The reason for the device state change is unknown.
-        
NM_DEVICE_STATE_REASON_NONE = 1

-          The state change is normal.
-        
NM_DEVICE_STATE_REASON_NOW_MANAGED = 2

-          The device is now managed.
-        
NM_DEVICE_STATE_REASON_NOW_UNMANAGED = 3

-          The device is no longer managed.
-        
NM_DEVICE_STATE_REASON_CONFIG_FAILED = 4

-          The device could not be readied for configuration.
-        
NM_DEVICE_STATE_REASON_CONFIG_UNAVAILABLE = 5

-          IP configuration could not be reserved (no available address, timeout, etc).
-        
NM_DEVICE_STATE_REASON_CONFIG_EXPIRED = 6

-          The IP configuration is no longer valid.
-        
NM_DEVICE_STATE_REASON_NO_SECRETS = 7

-          Secrets were required, but not provided.
-        
NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT = 8

-          The 802.1X supplicant disconnected from the access point or authentication server.
-        
NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED = 9

-          Configuration of the 802.1X supplicant failed.
-        
NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED = 10

-          The 802.1X supplicant quit or failed unexpectedly.
-        
NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT = 11

-          The 802.1X supplicant took too long to authenticate.
-        
NM_DEVICE_STATE_REASON_PPP_START_FAILED = 12

-          The PPP service failed to start within the allowed time.
-        
NM_DEVICE_STATE_REASON_PPP_DISCONNECT = 13

-          The PPP service disconnected unexpectedly.
-        
NM_DEVICE_STATE_REASON_PPP_FAILED = 14

-          The PPP service quit or failed unexpectedly.
-        
NM_DEVICE_STATE_REASON_DHCP_START_FAILED = 15

-          The DHCP service failed to start within the allowed time.
-        
NM_DEVICE_STATE_REASON_DHCP_ERROR = 16

-          The DHCP service reported an unexpected error.
-        
NM_DEVICE_STATE_REASON_DHCP_FAILED = 17

-          The DHCP service quit or failed unexpectedly.
-        
NM_DEVICE_STATE_REASON_SHARED_START_FAILED = 18

-          The shared connection service failed to start.
-        
NM_DEVICE_STATE_REASON_SHARED_FAILED = 19

-          The shared connection service quit or failed unexpectedly.
-        
NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED = 20

-          The AutoIP service failed to start.
-        
NM_DEVICE_STATE_REASON_AUTOIP_ERROR = 21

-          The AutoIP service reported an unexpected error.
-        
NM_DEVICE_STATE_REASON_AUTOIP_FAILED = 22

-          The AutoIP service quit or failed unexpectedly.
-        
NM_DEVICE_STATE_REASON_MODEM_BUSY = 23

-          Dialing failed because the line was busy.
-        
NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE = 24

-          Dialing failed because there was no dial tone.
-        
NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER = 25

-          Dialing failed because there was carrier.
-        
NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT = 26

-          Dialing timed out.
-        
NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED = 27

-          Dialing failed.
-        
NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED = 28

-          Modem initialization failed.
-        
NM_DEVICE_STATE_REASON_GSM_APN_FAILED = 29

-          Failed to select the specified GSM APN.
-        
NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING = 30

-          Not searching for networks.
-        
NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED = 31

-          Network registration was denied.
-        
NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT = 32

-          Network registration timed out.
-        
NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED = 33

-          Failed to register with the requested GSM network.
-        
NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED = 34

-          PIN check failed.
-        
NM_DEVICE_STATE_REASON_FIRMWARE_MISSING = 35

-          Necessary firmware for the device may be missing.
-        
NM_DEVICE_STATE_REASON_REMOVED = 36

-          The device was removed.
-        
NM_DEVICE_STATE_REASON_SLEEPING = 37

-          NetworkManager went to sleep.
-        
NM_DEVICE_STATE_REASON_CONNECTION_REMOVED = 38

-          The device's active connection was removed or disappeared.
-        
NM_DEVICE_STATE_REASON_USER_REQUESTED = 39

-          A user or client requested the disconnection.
-        
NM_DEVICE_STATE_REASON_CARRIER = 40

-          The device's carrier/link changed.
-        
NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED = 41

-          The device's existing connection was assumed.
-        
NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE = 42

-          The 802.1x supplicant is now available.
-        
NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND = 43

-          The modem could not be found.
-        
NM_DEVICE_STATE_REASON_BT_FAILED = 44

-          The Bluetooth connection timed out or failed.
-        
NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED = 45

-          GSM Modem's SIM Card not inserted.
-        
NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED = 46

-          GSM Modem's SIM Pin required.
-        
NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED = 47

-          GSM Modem's SIM Puk required.
-        
NM_DEVICE_STATE_REASON_GSM_SIM_WRONG = 48

-          GSM Modem's SIM wrong
-        
NM_DEVICE_STATE_REASON_INFINIBAND_MODE = 49

-          InfiniBand device does not support connected mode.
-        
NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED = 50

-          A dependency of the connection failed.
-        
NM_DEVICE_STATE_REASON_BR2684_FAILED = 51

-          Problem with the RFC 2684 Ethernet over ADSL bridge.
-        
NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE = 52

-          ModemManager was not running or quit unexpectedly.
-        
NM_DEVICE_STATE_REASON_SSID_NOT_FOUND = 53

-          The 802.11 Wi-Fi network could not be found.
-        
NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED = 54

-          A secondary connection of the base connection failed.
-        
NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED = 55

-          DCB or FCoE setup failed.
-        
NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED = 56

-          teamd control failed.
-        
NM_DEVICE_STATE_REASON_MODEM_FAILED = 57

-          Modem failed or no longer available.
-        
NM_DEVICE_STATE_REASON_MODEM_AVAILABLE = 58

-          Modem now ready and available.
-        
NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT = 59

-          The SIM PIN was incorrect.
-        
NM_DEVICE_STATE_REASON_NEW_ACTIVATION = 60

-          A new connection activation was enqueued.
-        
NM_DEVICE_STATE_REASON_PARENT_CHANGED = 61

-          The device's parent changed.
-        
NM_DEVICE_STATE_REASON_PARENT_MANAGED_CHANGED = 62

-          The device parent's management changed.
-        
NM_METERED
NM_METERED_UNKNOWN = 0

-          The device metered status is unknown.
-        
NM_METERED_YES = 1

-          The device is metered and the value was statically set.
-        
NM_METERED_NO = 2

-          The device is not metered and the value was statically set.
-        
NM_METERED_GUESS_YES = 3

-          The device is metered and the value was guessed.
-        
NM_METERED_GUESS_NO = 4

-          The device is not metered and the value was guessed.
-        
Sets of flags:
NM_DEVICE_CAP
NM_DEVICE_CAP_NONE = 0x0
Null capability.
NM_DEVICE_CAP_NM_SUPPORTED = 0x1
The device is supported by NetworkManager.
NM_DEVICE_CAP_CARRIER_DETECT = 0x2
The device supports carrier detection.
Structure types:
NM_DEVICE_STATE_REASON_STRUCT - (
-        u: state, u: reason
-        )
-      
Arrays of NM_DEVICE_STATE_REASON_STRUCT don't generally
-            make sense.
Members
state -
-      u
-      (NM_DEVICE_STATE)
-    

-          The device state.
-        
reason -
-      u
-      (NM_DEVICE_STATE_REASON)
-    

-          The reason for originally changing to the device state.
-        

-
-  
org.freedesktop.NetworkManager.Device.Adsl
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found.
-      

-
-  
org.freedesktop.NetworkManager.Device.Bond
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      
Slaves -
-      ao -
-      (read)

-        Array of object paths representing devices which are currently
-	slaved to this device.
-      

-
-  
org.freedesktop.NetworkManager.Device.Bridge
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      
Slaves -
-      ao -
-      (read)

-        Array of object paths representing devices which are currently
-	slaved to this device.
-      

-
-  
org.freedesktop.NetworkManager.Device.Bluetooth
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Bluetooth hardware address of the device.
-      
Name -
-      s -
-      (read)

-        Bluetooth name of the device.
-      
BtCapabilities -
-      u -
-      (read)
-      (NM_BT_CAPABILITIES)
-    

-        Bluetooth capabilities of the device (either DUN or NAP).
-      
Sets of flags:
NM_BT_CAPABILITIES

-        Flags describing the capabilities of a Bluetooth device.
-      
NM_BT_CAPABILITY_NONE = 0x0
The device has no recognized capabilities.
NM_BT_CAPABILITY_DUN = 0x1
The device supports Bluetooth Dial-Up Networking.
NM_BT_CAPABILITY_PAN = 0x2
The device supports Bluetooth Personal Area Networking.

-
-  
org.freedesktop.NetworkManager.Device.Wired
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Active hardware address of the device.
-      
PermHwAddress -
-      s -
-      (read)

-        Permanent hardware address of the device.
-      
Speed -
-      u -
-      (read)

-        Design speed of the device, in megabits/second (Mb/s).
-      
S390Subchannels -
-      as -
-      (read)

-        Array of S/390 subchannels for S/390 or z/Architecture devices.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      

-
-  
org.freedesktop.NetworkManager.Device.Generic
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
TypeDescription -
-      s -
-      (read)

-        A (non-localized) description of the interface type, if known.
-      

-
-  
org.freedesktop.NetworkManager.Device.Infiniband
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      

-
-  
org.freedesktop.NetworkManager.Device.IPTunnel
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Mode -
-      u -
-      (read)

-        The tunneling mode.
-      
Parent -
-      o -
-      (read)

-        The object path of the parent device.
-      
Local -
-      s -
-      (read)

-        The local endpoint of the tunnel.
-      
Remote -
-      s -
-      (read)

-        The remote endpoint of the tunnel.
-      
Ttl -
-      y -
-      (read)

-        The TTL assigned to tunneled packets. 0 is a special value
-        meaning that packets inherit the TTL value
-      
Tos -
-      y -
-      (read)

-        The type of service (IPv4) or traffic class (IPv6) assigned to
-        tunneled packets.
-      
PathMtuDiscovery -
-      b -
-      (read)

-        Whether path MTU discovery is enabled on this tunnel.
-      
InputKey -
-      s -
-      (read)

-        The key used for incoming packets.
-      
OutputKey -
-      s -
-      (read)

-        The key used for outgoing packets.
-      
EncapsulationLimit -
-      y -
-      (read)

-        How many additional levels of encapsulation are permitted to
-        be prepended to packets. This property applies only to IPv6
-        tunnels.
-      
FlowLabel -
-      u -
-      (read)

-        The flow label to assign to tunnel packets. This property
-        applies only to IPv6 tunnels.
-      

-
-  
org.freedesktop.NetworkManager.Device.Macvlan
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Parent -
-      o -
-      (read)

-        The object path of the parent device.
-      
Mode -
-      s -
-      (read)

-        The macvlan mode, one of "private", "vepa", "bridge", or "passthru".
-      
NoPromisc -
-      b -
-      (read)

-        Whether the device is blocked from going into promiscuous mode.
-      
Tap -
-      b -
-      (read)

-        Whether the device is a macvtap.
-      

-
-  
org.freedesktop.NetworkManager.Device.Modem
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
ModemCapabilities -
-      u -
-      (read)
-      (NM_DEVICE_MODEM_CAPABILITIES)
-    

-        The generic family of access technologies the modem supports.  Not all
-        capabilities are available at the same time however; some modems require
-        a firmware reload or other reinitialization to switch between eg CDMA/EVDO
-        and GSM/UMTS.
-      
CurrentCapabilities -
-      u -
-      (read)
-      (NM_DEVICE_MODEM_CAPABILITIES)
-    

-        The generic family of access technologies the modem currently supports
-        without a firmware reload or reinitialization.
-      
Sets of flags:
NM_DEVICE_MODEM_CAPABILITIES

-        Flags describing one or more of the general access technology families
-        that a modem device supports.
-      
NM_DEVICE_MODEM_CAPABILITY_NONE = 0x0
Modem has no capabilties.
NM_DEVICE_MODEM_CAPABILITY_POTS = 0x1

-          Modem supports the analog wired telephone network (ie 56k dialup) and
-          does not have wireless/cellular capabilities.
-        
NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO = 0x2

-          Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO
-          revision A, or EVDO revision B.
-        
NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS = 0x4

-          Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or
-          HSPA+ packet switched data capability.
-        
NM_DEVICE_MODEM_CAPABILITY_LTE = 0x8

-          Modem has at LTE data capability.
-        

-
-  
org.freedesktop.NetworkManager.Device.OlpcMesh
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )

-            Emitted when the wireless device's properties changed.
-        
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary containing the FIXME: check changed parameters.
-            
Properties:
HwAddress -
-      s -
-      (read)

-        The hardware address of the device.
-      
Companion -
-      o -
-      (read)

-        The object path of the companion device.
-      
ActiveChannel -
-      u -
-      (read)

-        The currently active channel.
-      

-
-  
org.freedesktop.NetworkManager.Device.Team
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      
Slaves -
-      ao -
-      (read)

-        Array of object paths representing devices which are currently
-	slaved to this device.
-      

-
-  
org.freedesktop.NetworkManager.Device.Tun
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Owner -
-      x -
-      (read)

-        The uid of the tunnel owner, or -1 if it has no owner.
-      
Group -
-      x -
-      (read)

-        The gid of the tunnel group, or -1 if it has no owner.
-      
Mode -
-      s -
-      (read)

-        The tunnel mode, either "tun" or "tap".
-      
NoPi -
-      b -
-      (read)

-        The tunnel's "TUN_NO_PI" flag; true if no protocol info is
-	prepended to the tunnel packets.
-      
VnetHdr -
-      b -
-      (read)

-        The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets
-	include a virtio network header.
-      
MultiQueue -
-      b -
-      (read)

-        The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to
-        the tap device multiple times, for multiple send/receive
-        queues.
-      
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      

-
-  
org.freedesktop.NetworkManager.Device.Veth
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Peer -
-      o -
-      (read)

-        The object path of the device's peer.
-      

-
-  
org.freedesktop.NetworkManager.Device.Vlan
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Carrier -
-      b -
-      (read)

-        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
-      
Parent -
-      o -
-      (read)

-        Object path of the parent device of this VLAN device.
-      
VlanId -
-      u -
-      (read)

-        The VLAN ID of this VLAN interface.
-      

-
-  
org.freedesktop.NetworkManager.Device.Vxlan
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Parent -
-      o -
-      (read)

-        The object path of the parent device (if the VXLAN is not
-	purely internal to this host).
-      
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
Id -
-      u -
-      (read)

-        The VXLAN Network Identifier (VNI).
-      
Group -
-      s -
-      (read)

-        The IP (v4 or v6) multicast group used to communicate with other physical
-	hosts on this VXLAN.
-      
Local -
-      s -
-      (read)

-        The local IPv4 or IPv6 address to use when sending VXLAN packets to other
-	physical hosts.
-      
Tos -
-      y -
-      (read)

-        The value to use in the IP ToS field for VXLAN packets sent to
-	other physical hosts.
-      
Ttl -
-      y -
-      (read)

-        The value to use in the IP TTL field for VXLAN packets sent to
-	other physical hosts.
-      
Learning -
-      b -
-      (read)

-        True if the VXLAN dynamically learns remote IP addresses.
-      
Ageing -
-      u -
-      (read)

-        The interval in seconds at which the kernel purges stale
-        cached addresses.
-      
Limit -
-      u -
-      (read)

-        The maximum number of entries that can be added to the VXLAN's
-	forwarding table.
-      
DstPort -
-      q -
-      (read)

-        Destination port for outgoing VXLAN packets.
-      
SrcPortMin -
-      q -
-      (read)

-        The lowest source port number to use for outgoing VXLAN packets.
-      
SrcPortMax -
-      q -
-      (read)

-        The highest source port number to use for outgoing VXLAN packets.
-      
Proxy -
-      b -
-      (read)

-        True if the VXLAN is implementing DOVE ARP proxying for remote
-        clients.
-      
Rsc -
-      b -
-      (read)

-        True if the VXLAN is implementing DOVE route short-circuiting
-	of known remote IP addresses.
-      
L2miss -
-      b -
-      (read)

-        True if the VXLAN will emit netlink notifications of L2 switch
-        misses.
-      
L3miss -
-      b -
-      (read)

-        True if the VXLAN will emit netlink notifications of L3 switch
-        misses.
-      

-
-  
org.freedesktop.NetworkManager.Device.Wireless
Methods:
GetAccessPoints (
-        
-        ) →
-        ao

-        DEPRECATED.  Get the list of access points visible to this device.  Note
-        that this list does not include access points which hide their SSID.  To
-        retrieve a list of all access points (including hidden ones) use the
-        GetAllAccessPoints() method.
-      
Returns
access_points -
-      ao

-          List of access point object paths.
-        
GetAllAccessPoints (
-        
-        ) →
-        ao

-        Get the list of all access points visible to this device, including
-        hidden ones for which the SSID is not yet known.
-      
Returns
access_points -
-      ao

-          List of access point object paths.
-        
RequestScan (
-        a{sv}: options
-        ) →
-        nothing

-        Request the device to scan
-      
Parameters
options -
-      a{sv}

-          Options of scan.
-          Currently 'ssids' option with value of "aay" type is supported.
-        
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )

-            Emitted when the wireless device's properties changed.
-        
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary containing the FIXME: check changed parameters.
-            
AccessPointAdded (
-        o: access_point
-        )

-            Emitted when a new access point is found by the device.
-        
Parameters
access_point -
-      o

-                The object path of the newly found access point.
-            
AccessPointRemoved (
-        o: access_point
-        )

-            Emitted when an access point disappears from view of the device.
-        
Parameters
access_point -
-      o

-                The object path of the access point that has disappeared.
-            
Properties:
HwAddress -
-      s -
-      (read)

-        The active hardware address of the device.
-      
PermHwAddress -
-      s -
-      (read)

-        The permanent hardware address of the device.
-      
Mode -
-      u -
-      (read)
-      (NM_802_11_MODE)
-    

-        The operating mode of the wireless device.
-      
Bitrate -
-      u -
-      (read)

-        The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
-      
AccessPoints -
-      ao -
-      (read)

-        List of object paths of access point visible to this wireless device.
-      
ActiveAccessPoint -
-      o -
-      (read)

-        Object path of the access point currently used by the wireless device.
-      
WirelessCapabilities -
-      u -
-      (read)
-      (NM_802_11_DEVICE_CAP)
-    

-        The capabilities of the wireless device.
-      
Sets of flags:
NM_802_11_DEVICE_CAP

-        Flags describing the capabilities of a wireless device.
-      
NM_802_11_DEVICE_CAP_NONE = 0x0
Null capability - syntactic sugar for no capabilities supported.  Do not AND this with other capabilities!
NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1
The device supports the 40-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2
The device supports the 104-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4
The device supports the TKIP cipher.
NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8
The device supports the CCMP cipher.
NM_802_11_DEVICE_CAP_WPA = 0x10
The device supports the WPA encryption/authentication protocol.
NM_802_11_DEVICE_CAP_RSN = 0x20
The device supports the RSN encryption/authentication protocol.
NM_802_11_DEVICE_CAP_AP = 0x40
The device supports Access Point mode.
NM_802_11_DEVICE_CAP_ADHOC = 0x80
The device supports Ad-Hoc mode.
NM_802_11_DEVICE_CAP_FREQ_VALID = 0x100

-	  The device properly reports information about supported
-	  frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and
-	  NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid.
-	
NM_802_11_DEVICE_CAP_FREQ_2GHZ = 0x200

-          The device supports 2.4GHz frequencies.
-        
NM_802_11_DEVICE_CAP_FREQ_5GHZ = 0x400

-          The device supports 5GHz frequencies.
-        

-
-  
org.freedesktop.NetworkManager.Device.WiMax
Methods:
GetNspList (
-        
-        ) →
-        ao

-        Get the list of NSPs visible to this device.
-      
Returns
nsps -
-      ao

-          List of NSP object paths
-        
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )

-            Emitted when the WiMax device's properties changed.
-        
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values.
-            
NspAdded (
-        o: nsp
-        )

-            Emitted when a new NSP is found by the device.
-        
Parameters
nsp -
-      o

-                The object path of the newly found NSP.
-            
NspRemoved (
-        o: nsp
-        )

-            Emitted when an NSP disappears from view of the device.
-        
Parameters
nsp -
-      o

-                The object path of the NSP that has disappeared.
-            
Properties:
Nsps -
-      ao -
-      (read)

-        List of object paths of Network Service Providers (NSPs) visible to this
-        WiMAX device.
-      
HwAddress -
-      s -
-      (read)

-        Hardware address of the device.
-      
CenterFrequency -
-      u -
-      (read)

-        Center frequency (in KHz) of the radio channel the device is using to
-        communicate with the network when connected.  Has no meaning when the
-        device is not connected.
-      
Rssi -
-      i -
-      (read)

-        RSSI of the current radio link in dBm.  This value indicates how strong
-        the raw received RF signal from the base station is, but does not
-        indicate the overall quality of the radio link.  Has no meaning when the
-        device is not connected.
-      
Cinr -
-      i -
-      (read)

-        CINR (Carrier to Interference + Noise Ratio) of the current radio link
-        in dB.  CINR is a more accurate measure of radio link quality.  Has no
-        meaning when the device is not connected.
-      
TxPower -
-      i -
-      (read)

-        Average power of the last burst transmitted by the device, in units of
-        0.5 dBm.  i.e. a TxPower of -11 represents an actual device TX power of
-        -5.5 dBm.  Has no meaning when the device is not connected.
-      
Bsid -
-      s -
-      (read)

-        The ID of the serving base station as received from the network.  Has
-        no meaning when the device is not connected.
-      
ActiveNsp -
-      o -
-      (read)

-        Object path of the NSP currently used by the WiMax device.
-      

-
-  
org.freedesktop.NetworkManager.WiMax.Nsp
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values.
-            
Properties:
Name -
-      s -
-      (read)
The name of the NSP.
SignalQuality -
-      u -
-      (read)
The current signal quality of the NSP, in percent.
NetworkType -
-      u -
-      (read)
-      (NM_WIMAX_NSP_NETWORK_TYPE)
-    
The network type of the NSP.
Sets of flags:
NM_WIMAX_NSP_NETWORK_TYPE

-        Network type of the NSP.
-      
NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0x0
Unknown network.
NM_WIMAX_NSP_NETWORK_TYPE_HOME = 0x1
Home network.
NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 0x2
Partner network.
NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 0x3
Roaming partner network.

-
-  
org.freedesktop.NetworkManager.IP4Config
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-          A dictionary mapping property names to variant boxed values
-        
Properties:
Addresses -
-      aau -
-      (read)

-	Array of arrays of IPv4 address/prefix/gateway.  All 3
-	elements of each array are in network byte order.  Essentially:
-	[(addr, prefix, gateway), (addr, prefix, gateway), ...]
-
-	Deprecated: use AddressData and Gateway
-      
AddressData -
-      aa{sv} -
-      (read)

-	Array of IP address data objects. All addresses will include
-	"address" (an IP address string), and "prefix" (a uint). Some
-	addresses may include additional attributes.
-      
Gateway -
-      s -
-      (read)
The gateway in use.
Routes -
-      aau -
-      (read)

-	Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of
-	each tuple are in network byte order. 'route' and 'next hop'
-	are IPv4 addresses, while prefix and metric are simple
-	unsigned integers. Essentially: [(route, prefix, next-hop,
-	metric), (route, prefix, next-hop, metric), ...]
-
-	Deprecated: use RouteData
-      
RouteData -
-      aa{sv} -
-      (read)

-	Array of IP route data objects. All routes will include "dest"
-	(an IP address string) and "prefix" (a uint). Some routes may
-	include "next-hop" (an IP address string), "metric" (a uint),
-	and additional attributes.
-      
Nameservers -
-      au -
-      (read)
The nameservers in use.
Domains -
-      as -
-      (read)
A list of domains this address belongs to.
Searches -
-      as -
-      (read)
A list of dns searches.
DnsOptions -
-      as -
-      (read)

-	A list of DNS options that modify the behavior of the DNS
-	resolver. See resolv.conf(5) manual page for the list of
-	supported options.
-      
WinsServers -
-      au -
-      (read)
The Windows Internet Name Service servers associated with the connection.  Each address is in network byte order.

-
-  
org.freedesktop.NetworkManager.IP6Config
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-          A dictionary mapping property names to variant boxed values
-        
Properties:
Addresses -
-      a(ayuay) -
-      (read)

-	Array of tuples of IPv6 address/prefix/gateway.
-
-	Deprecated: use AddressData and Gateway.
-      
AddressData -
-      aa{sv} -
-      (read)

-	Array of IP address data objects. All addresses will include
-	"address" (an IP address string), and "prefix" (a uint). Some
-	addresses may include additional attributes.
-      
Gateway -
-      s -
-      (read)
The gateway in use.
Routes -
-      a(ayuayu) -
-      (read)

-	Tuples of IPv6 route/prefix/next-hop/metric.
-
-	Deprecated: use RouteData
-      
RouteData -
-      aa{sv} -
-      (read)

-	Array of IP route data objects. All routes will include "dest"
-	(an IP address string) and "prefix" (a uint). Some routes may
-	include "next-hop" (an IP address string), "metric" (a uint),
-	and additional attributes.
-      
Nameservers -
-      aay -
-      (read)
The nameservers in use.
Domains -
-      as -
-      (read)
A list of domains this address belongs to.
Searches -
-      as -
-      (read)
A list of dns searches.
DnsOptions -
-      as -
-      (read)

-	A list of DNS options that modify the behavior of the DNS
-	resolver. See resolv.conf(5) manual page for the list of
-	supported options.
-      

-
-    
org.freedesktop.NetworkManager.DHCP4Config

-            Options and configuration returned by the IPv4 DHCP server.
-        
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                    A dictionary mapping property names to variant boxed values
-                
Properties:
Options -
-      a{sv} -
-      (read)
Configuration options returned by a DHCP server, if any.

-
-    
org.freedesktop.NetworkManager.DHCP6Config

-            Options and configuration returned by the IPv6 DHCP server.
-        
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                    A dictionary mapping property names to variant boxed values
-                
Properties:
Options -
-      a{sv} -
-      (read)
Configuration options returned by a DHCP server, if any.

-
-  
org.freedesktop.NetworkManager.Settings

-      The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
-    
Methods:
ListConnections (
-        
-        ) →
-        ao

-        List the saved network connections known to NetworkManager.
-      
Returns
connections -
-      ao

-          List of connections.
-        
GetConnectionByUuid (
-        s: uuid
-        ) →
-        o

-        Retrieve the object path of a connection, given that connection's UUID.
-      
Parameters
uuid -
-      s

-          The UUID to find the connection object path for.
-        
Returns
connection -
-      o

-          The connection's object path.
-        
AddConnection (
-        a{sa{sv}}: connection
-        ) →
-        o

-        Add new connection and save it to disk.  This operation does not start
-        the network connection unless (1) device is idle and able to connect to
-        the network described by the new connection, and (2) the connection
-        is allowed to be started automatically.
-      
Parameters
connection -
-      a{sa{sv}}

-          Connection settings and properties.
-        
Returns
path -
-      o

-          Object path of the new connection that was just added.
-        
AddConnectionUnsaved (
-        a{sa{sv}}: connection
-        ) →
-        o

-        Add new connection but do not save it to disk immediately.  This
-        operation does not start the network connection unless (1) device is
-        idle and able to connect to the network described by the new connection,
-        and (2) the connection is allowed to be started automatically.
-
-        Use the 'Save' method on the connection to save these changes
-        to disk. Note that unsaved changes will be lost if the
-        connection is reloaded from disk (either automatically on file
-        change or due to an explicit ReloadConnections call).
-      
Parameters
connection -
-      a{sa{sv}}

-          Connection settings and properties.
-        
Returns
path -
-      o

-          Object path of the new connection that was just added.
-        
LoadConnections (
-        as: filenames
-        ) →
-        b, as

-        Loads or reloads the indicated connections from disk. You
-        should call this after making changes directly to an on-disk
-        connection file to make sure that NetworkManager sees the
-        changes. (If "monitor-connection-files" in NetworkManager.conf
-        is "true", then this will have no real effect, but is
-        harmless.) As with AddConnection(), this operation does not
-        necessarily start the network connection.
-      
Parameters
filenames -
-      as

-          Array of paths to on-disk connection profiles in directories
-          monitored by NetworkManager.
-        
Returns
status -
-      b

-          Success or failure of the operation as a whole. True if
-          NetworkManager at least tried to load the indicated
-          connections, even if it did not succeed. False if an error
-          occurred before trying to load the connections (eg,
-          permission denied).
-        
failures -
-      as

-          Paths of connection files that could not be loaded.
-        
ReloadConnections (
-        
-        ) →
-        b

-        Tells NetworkManager to reload all connection files from disk,
-        including noticing any added or deleted connection files. By
-        default, connections are re-read automatically any time they
-        change, so you only need to use this command if you have set
-        "monitor-connection-files=false" in NetworkManager.conf.
-      
Returns
status -
-      b

-          Success or failure.
-        
SaveHostname (
-        s: hostname
-        ) →
-        nothing

-        Save the hostname to persistent configuration.
-      
Parameters
hostname -
-      s

-          The hostname to save to persistent configuration.  If blank, the persistent hostname is cleared.
-        
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
NewConnection (
-        o: connection
-        )

-        Emitted when a new connection has been added after NetworkManager has
-        started up and initialized.  This signal is not emitted for connections
-        read while starting up, because NetworkManager's D-Bus service is only
-        available after all connections have been read, and to prevent spamming
-        listeners with too many signals at one time.  To retrieve the initial
-        connection list, call the ListConnections() method once, and then listen
-        for individual Settings.NewConnection and Settings.Connection.Deleted
-        signals for further updates.
-      
Parameters
connection -
-      o

-          Object path of the new connection.
-        
ConnectionRemoved (
-        o: connection
-        )

-        Emitted when a connection is no longer available.  This happens when
-        the connection is deleted or if it is no longer accessible by any of
-        the system's logged-in users.  After receipt of this signal, the
-        connection no longer exists and cannot be used.  Also see the
-        Settings.Connection.Removed signal.
-      
Parameters
connection -
-      o

-          Object path of the removed connection.
-        
Properties:
Connections -
-      ao -
-      (read)

-        List of object paths of available network connection profiles.
-      
Hostname -
-      s -
-      (read)

-        The machine hostname stored in persistent configuration.
-      
CanModify -
-      b -
-      (read)

-        If true, adding and modifying connections is supported.
-      

-
-
-    
org.freedesktop.NetworkManager.Settings.Connection

-            Represents a single network connection configuration.
-        
Methods:
Update (
-        a{sa{sv}}: properties
-        ) →
-        nothing

-            Update the connection with new settings and properties (replacing
-            all previous settings and properties) and save the connection to
-            disk.  Secrets may be part of the update request, and will be either
-            stored in persistent storage or sent to a Secret Agent for storage,
-            depending on the flags associated with each secret.
-          
Parameters
properties -
-      a{sa{sv}}

-              New connection settings, properties, and (optionally) secrets.
-            
UpdateUnsaved (
-        a{sa{sv}}: properties
-        ) →
-        nothing

-            Update the connection with new settings and properties (replacing
-            all previous settings and properties) but do not immediately save
-            the connection to disk.  Secrets may be part of the update request
-            and may sent to a Secret Agent for storage, depending on the
-            flags associated with each secret.
-
-            Use the 'Save' method to save these changes to disk. Note
-            that unsaved changes will be lost if the connection is
-            reloaded from disk (either automatically on file change or
-            due to an explicit ReloadConnections call).
-          
Parameters
properties -
-      a{sa{sv}}

-              New connection settings, properties, and (optionally) secrets.
-            
Delete (
-        
-        ) →
-        nothing

-            Delete the connection.
-          
GetSettings (
-        
-        ) →
-        a{sa{sv}}

-                Get the settings maps describing this network configuration.
-                This will never include any secrets required for connection
-                to the network, as those are often protected.  Secrets must
-                be requested separately using the GetSecrets() call.
-            
Returns
settings -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    The nested settings maps describing this object.
-                
GetSecrets (
-        s: setting_name
-        ) →
-        a{sa{sv}}

-                Get the secrets belonging to this network configuration.  Only
-                secrets from persistent storage or a Secret Agent running in
-                the requestor's session will be returned.  The user will never
-                be prompted for secrets as a result of this request.
-            
Parameters
setting_name -
-      s

-                    Name of the setting to return secrets for.  If empty, all
-                    all secrets will be returned.
-                
Returns
secrets -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    Nested settings maps containing secrets.
-                
ClearSecrets (
-        
-        ) →
-        nothing

-            Clear the secrets belonging to this network connection profile.
-          
Save (
-        
-        ) →
-        nothing

-                Saves a "dirty" connection (that had previously been
-                updated with UpdateUnsaved) to persistent storage.
-            
Signals:
Updated (
-        
-        )

-                Emitted when any settings or permissions change.  When handling
-                this signal, clients should re-read the connection using the
-                GetSettings method to get the changes and to ensure the client
-                still has permission to access the connection.
-            
Removed (
-        
-        )

-                Emitted when this connection is no longer available.  This
-                happens when the connection is deleted or if it is no longer
-                accessible by any of the system's logged-in users.  After
-                receipt of this signal, the object no longer exists.  Also
-                see the Settings.ConnectionRemoved signal.
-            
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                    A dictionary mapping property names to variant boxed values.
-                
Properties:
Unsaved -
-      b -
-      (read)

-                If set, indicates that the in-memory state of the
-                connection does not match the on-disk state. This flag
-                will be set when UpdateUnsaved() is called or when any
-                connection details change, and cleared when the connection
-                is saved to disk via Save() or from internal operations.
-            

-
-
-  
org.freedesktop.NetworkManager.Connection.Active

-      Objects that implement the Connection.Active interface represent an attempt
-      to connect to a network using the details provided by a Connection object.
-      The Connection.Active object tracks the life-cycle of the connection
-      attempt and if successful indicates whether the connected network is the
-      "default" or preferred network for access.
-      NetworkManager has the concept of connections, which can be thought of as
-      settings, a profile or a configuration that can be applied on a networking
-      device.
-      Such settings-connections are exposed as D-Bus object and the active-connection
-      expresses this relationship between device and settings-connection.
-      At any time a settings-connection can only be activated on one device and vice
-      versa. However, during activation and deactivation multiple active-connections
-      can reference the same device or settings-connection as they are waiting to
-      be activated or to be deactivated.
-    
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
Properties:
Connection -
-      o -
-      (read)

-        The path of the connection.
-      
SpecificObject -
-      o -
-      (read)

-        A specific object associated with the active connection.  This property
-        reflects the specific object used during connection activation, and will
-        not change over the lifetime of the ActiveConnection once set.
-      
Id -
-      s -
-      (read)

-        The ID of the connection, provided as a convenience so that clients
-        do not have to retrieve all connection details.
-      
Uuid -
-      s -
-      (read)

-        The UUID of the connection, provided as a convenience so that clients
-        do not have to retrieve all connection details.
-      
Type -
-      s -
-      (read)

-        The type of the connection, provided as a convenience so that clients
-        do not have to retrieve all connection details.
-      
Devices -
-      ao -
-      (read)

-        Array of object paths representing devices which are part of this active
-        connection.
-      
State -
-      u -
-      (read)
-      (NM_ACTIVE_CONNECTION_STATE)
-    

-        The state of this active connection.
-      
Default -
-      b -
-      (read)

-        Whether this active connection is the default IPv4 connection, i.e.
-        whether it currently owns the default IPv4 route.
-      
Ip4Config -
-      o -
-      (read)

-        Object path of the Ip4Config object describing the configuration of the
-        connection. Only valid when the connection is in the
-        NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
-      
Dhcp4Config -
-      o -
-      (read)

-        Object path of the Dhcp4Config object describing the DHCP options
-        returned by the DHCP server (assuming the connection used DHCP). Only
-        valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
-        state.
-      
Default6 -
-      b -
-      (read)

-        Whether this active connection is the default IPv6 connection, i.e.
-        whether it currently owns the default IPv6 route.
-      
Ip6Config -
-      o -
-      (read)

-        Object path of the Ip6Config object describing the configuration of the
-        connection. Only valid when the connection is in the
-        NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
-      
Dhcp6Config -
-      o -
-      (read)

-        Object path of the Dhcp6Config object describing the DHCP options
-        returned by the DHCP server (assuming the connection used DHCP). Only
-        valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
-        state.
-      
Vpn -
-      b -
-      (read)

-        Whether this active connection is also a VPN connection.
-      
Master -
-      o -
-      (read)

-        The path to the master device if the connection is a slave.
-      
Enumerated types:
NM_ACTIVE_CONNECTION_STATE
NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0

-          The active connection is in an unknown state.
-        
NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1

-          The connection is activating.
-        
NM_ACTIVE_CONNECTION_STATE_ACTIVATED = 2

-          The connection is activated.
-        
NM_ACTIVE_CONNECTION_STATE_DEACTIVATING = 3

-          The connection is being torn down and cleaned up.
-        
NM_ACTIVE_CONNECTION_STATE_DEACTIVATED = 4

-          The connection is no longer active.
-        

-
-  
org.freedesktop.NetworkManager.AgentManager
Methods:
Register (
-        s: identifier
-        ) →
-        nothing

-        Called by secret Agents to register their ability to provide and save
-        network secrets.
-      
Parameters
identifier -
-      s

-          Identifies this agent; only one agent in each user session may use the
-          same identifier.  Identifier formatting follows the same rules as
-          D-Bus bus names with the exception that the ':' character is not
-          allowed.  The valid set of characters is "[A-Z][a-z][0-9]_-." and the
-          identifier is limited in length to 255 characters with a minimum
-          of 3 characters.  An example valid identifier is 'org.gnome.nm-applet'
-          (without quotes).
-        
RegisterWithCapabilities (
-        s: identifier, u: capabilities
-        ) →
-        nothing

-        Like Register() but indicates agent capabilities to NetworkManager.
-      
Parameters
identifier -
-      s

-            See the Register() method's identifier argument.
-        
capabilities -
-      u
-      (NM_SECRET_AGENT_CAPABILITIES)
-    

-            Indicates various agent capabilities to NetworkManager.
-        
Unregister (
-        
-        ) →
-        nothing

-        Called by secret Agents to notify NetworkManager that they will no
-        longer handle requests for network secrets.  Agents are automatically
-        unregistered when they disconnect from D-Bus.
-      
Interface has no signals.
Interface has no properties.

-
-
-    
org.freedesktop.NetworkManager.SecretAgent

-            Private D-Bus interface used by secret agents that store and provide
-            secrets to NetworkManager.  If an agent provides secrets to
-            NetworkManager as part of connection creation, and the some of those
-            secrets are "agent owned" the agent should store those secrets
-            itself and should not expect its SaveSecrets() method to be called.
-            SaveSecrets() will be called eg if some program other than the
-            agent itself (like a connection editor) changes the secrets out of
-            band.  The agent should implement this D-Bus interface on an object
-            with the path /org/freedesktop/NetworkManager/SecretAgent.
-        
Methods:
GetSecrets (
-        a{sa{sv}}: connection, o: connection_path, s: setting_name, as: hints, u: flags
-        ) →
-        a{sa{sv}}

-                Retrieve and return stored secrets, if any, or request new
-                secrets from the agent's user.  If user interaction is allowed
-                and the user enters new secrets, the agent is expected to save
-                the new secrets to persistent storage (if the secret's flags
-                include AGENT_OWNED) as NetworkManager will not send these
-                secrets back to the same agent via a SaveSecrets() call.  If
-                the user canceled any interaction, the agent should return the
-                UserCanceled error (see below).
-            
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    Nested settings maps containing the connection for which
-                    secrets are being requested.  This may contain system-owned
-                    secrets if the agent has successfully authenticated to
-                    modify system network settings and the GetSecrets request
-                    flags allow user interaction.
-                
connection_path -
-      o

-                    Object path of the connection for which secrets are being
-                    requested.
-                
setting_name -
-      s

-                    Setting name for which secrets are being requested.
-                
hints -
-      as

-                    Array of strings of key names in the requested setting for
-                    which NetworkManager thinks a secrets may be required,
-                    and/or well-known identifiers and data that may be useful
-                    to the client in processing the secrets request.  Note that
-                    it's not always possible to determine which secret is
-                    required, so in some cases no hints may be given.  The Agent
-                    should return any secrets it has, or that it thinks are
-                    required, regardless of what hints NetworkManager sends
-                    in this request.  Some hints have special prefixes that
-                    provide information to the agent; for example, VPN requests
-                    may send server-specific messages prefixed with
-                    "x-vpn-message:".
-                
flags -
-      u
-      (NM_SECRET_AGENT_GET_SECRETS_FLAGS)
-    

-                    Flags which modify the behavior of the secrets request.
-                    If true, new secrets are assumed to be invalid or incorrect,
-                    and the agent should ask the user for new secrets.  If false,
-                    existing secrets should be retrieved from storage and 
-                    returned without interrupting the user.
-                
Returns
secrets -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    Nested settings maps containing secrets.  Each setting MUST
-                    contain at least the 'name' field, containing the name of
-                    the setting, and one or more secrets.
-                
Possible errors
org.freedesktop.NetworkManager.SecretAgent.NotAuthorized

-                      Should be returned when the process requesting secrets is
-                      not authorized to do so (like if the caller is not root
-                      or not NetworkManager).
-                  
org.freedesktop.NetworkManager.SecretAgent.InvalidConnection

-                      Should be returned if the 'connection' argument is invalid.
-                  
org.freedesktop.NetworkManager.SecretAgent.UserCanceled

-                      Should be returned when the user has canceled the request.
-                  
org.freedesktop.NetworkManager.SecretAgent.AgentCanceled

-                      Should be returned when NetworkManager has requested that
-                      the agent cancel the request.
-                  
org.freedesktop.NetworkManager.SecretAgent.InternalError

-                      Should be returned if the agent has encountered some internal
-                      error processing the request.
-                  
org.freedesktop.NetworkManager.SecretAgent.NoSecrets

-                      Should be returned if there are no available secrets, for
-                      example if user interaction is not allowed and there are
-                      no secrets stored by the agent for this connection.
-                  
CancelGetSecrets (
-        o: connection_path, s: setting_name
-        ) →
-        nothing

-                Cancel a pending GetSecrets request for secrets of the given
-                connection.  Any GetSecrets request with the same
-                'connection_path' and 'setting_name' that are given in a
-                CancelGetSecrets request should be canceled.
-            
Parameters
connection_path -
-      o

-                    Object path of the connection for which, if secrets for
-                    the given 'setting_name' are being requested, the request
-                    should be canceled.
-                
setting_name -
-      s

-                    Setting name for which secrets for this connection were
-                    originally being requested.
-                
SaveSecrets (
-        a{sa{sv}}: connection, o: connection_path
-        ) →
-        nothing

-                Save given secrets to backing storage.
-            
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    Nested settings maps containing the entire connection
-                    (including secrets), for which the agent should save the
-                    secrets to backing storage.  This method will not be called
-                    when the agent itself is the process creating or updating
-                    a connection; in that case the agent is assumed to have
-                    already saved those secrets since it had them already.
-                
connection_path -
-      o

-                    Object path of the connection for which the agent should
-                    save secrets to backing storage.
-                
DeleteSecrets (
-        a{sa{sv}}: connection, o: connection_path
-        ) →
-        nothing

-                Delete secrets from backing storage.
-            
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-                    Nested settings maps containing the connection properties
-                    (sans secrets), for which the agent should delete the
-                    secrets from backing storage.
-                
connection_path -
-      o

-                    Object path of the connection for which the agent should
-                    delete secrets from backing storage.
-                
Interface has no signals.
Interface has no properties.
Sets of flags:
NM_SECRET_AGENT_GET_SECRETS_FLAGS

-            Flags modifying the behavior of GetSecrets request.
-          
NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0

-              No special behavior; by default no user interaction is allowed and
-              requests for secrets are fulfilled from persistent storage, or
-              if no secrets are available an error is returned.
-            
NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1

-              Allows the request to interact with the user, possibly prompting
-              via UI for secrets if any are required, or if none are found in
-              persistent storage.
-            
NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2

-              Explicitly prompt for new secrets from the user.  This flag
-              signals that NetworkManager thinks any existing secrets are
-              invalid or wrong.  This flag implies that interaction is allowed.
-            
NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED = 0x4

-              Set if the request was initiated by user-requested action via the
-              D-Bus interface, as opposed to automatically initiated by
-              NetworkManager in response to (for example) scan results or
-              carrier changes.
-            
NM_SECRET_AGENT_CAPABILITIES
NM_SECRET_AGENT_CAPABILITY_NONE = 0x0
No special capabilities.
NM_SECRET_AGENT_CAPABILITY_VPN_HINTS = 0x1

-                    The agent supports passing hints to VPN plugin authentication
-                    dialogs.
-                

-
-
-  
org.freedesktop.NetworkManager.VPN.Connection

-      Represents an active connection to a Virtual Private Network.
-    
Interface has no methods.
Signals:
PropertiesChanged (
-        a{sv}: properties
-        )
Parameters
properties -
-      a{sv}
-      (String_Variant_Map)
-    

-                A dictionary mapping property names to variant boxed values
-            
VpnStateChanged (
-        u: state, u: reason
-        )

-        Emitted when the state of the VPN connection has changed.
-      
Parameters
state -
-      u
-      (NM_VPN_CONNECTION_STATE)
-    

-          The new state of the VPN connection.
-        
reason -
-      u
-      (NM_VPN_CONNECTION_STATE_REASON)
-    

-          Reason code describing the change to the new state.
-        
Properties:
VpnState -
-      u -
-      (read)
-      (NM_VPN_CONNECTION_STATE)
-    
The VPN-specific state of the connection.
Banner -
-      s -
-      (read)
The banner string of the VPN connection.
Enumerated types:
NM_VPN_CONNECTION_STATE
NM_VPN_CONNECTION_STATE_UNKNOWN = 0

-          The state of the VPN connection is unknown.
-        
NM_VPN_CONNECTION_STATE_PREPARE = 1

-          The VPN connection is preparing to connect.
-        
NM_VPN_CONNECTION_STATE_NEED_AUTH = 2

-          The VPN connection needs authorization credentials.
-        
NM_VPN_CONNECTION_STATE_CONNECT = 3

-          The VPN connection is being established.  FIXME: Should be CONNECTING or CONNECTED.
-        
NM_VPN_CONNECTION_STATE_IP_CONFIG_GET = 4

-          The VPN connection is getting an IP address.  FIXME: Should be an -ING 
-        
NM_VPN_CONNECTION_STATE_ACTIVATED = 5

-          The VPN connection is active.
-        
NM_VPN_CONNECTION_STATE_FAILED = 6

-          The VPN connection failed.
-        
NM_VPN_CONNECTION_STATE_DISCONNECTED = 7

-          The VPN connection is disconnected.
-        
NM_VPN_CONNECTION_STATE_REASON
NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0

-          The reason for the VPN connection state change is unknown.
-        
NM_VPN_CONNECTION_STATE_REASON_NONE = 1

-          No reason was given for the VPN connection state change.
-        
NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED = 2

-          The VPN connection changed state because the user disconnected it.
-        
NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED = 3

-          The VPN connection changed state because the device it was using was disconnected.
-        
NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED = 4

-          The service providing the VPN connection was stopped.
-        
NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID = 5

-          The IP config of the VPN connection was invalid.
-        
NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT = 6

-          The connection attempt to the VPN service timed out.
-        
NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT = 7

-          A timeout occurred while starting the service providing the VPN connection.
-        
NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED = 8

-          Starting the service starting the service providing the VPN connection failed.
-        
NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS = 9

-          Necessary secrets for the VPN connection were not provided.
-        
NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED = 10

-          Authentication to the VPN server failed.
-        
NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED = 11

-          The connection was deleted from settings.
-        

-
-  
org.freedesktop.NetworkManager.VPN.Plugin

-      This interface is provided by plugins providing VPN services to the NetworkManager daemon.
-    
Methods:
Connect (
-        a{sa{sv}}: connection
-        ) →
-        nothing

-        Tells the plugin to connect.  Interactive secrets requests (eg, emitting
-        the SecretsRequired signal) are not allowed.
-      
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-          Describes the connection to be established.
-        
Possible errors
org.freedesktop.NetworkManager.VPN.Error.StartingInProgress

-      The plugin is already starting, and another connect request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted

-      The plugin is already connected, and another connect request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress

-      The plugin is already stopping, and another stop request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.BadArguments

-      The request could not be processed because it contained malformed
-      arguments, or arguments of unexpected type. It usually means that one of
-      the VPN setting data items or secrets was not of the expected type (i.e.
-      int, string, bool, etc).
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.LaunchFailed

-      A binary providing the service failed to launch.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.WrongState

-      The request could not be processed because the VPN plugin is in the wrong
-      state for this type of request.
-    (generic description)
ConnectInteractive (
-        a{sa{sv}}: connection, a{sv}: details
-        ) →
-        nothing

-        Tells the plugin to connect, allowing interactive secrets requests (eg
-        the plugin is allowed to emit the SecretsRequired signal if the VPN
-        service indicates that it needs additional secrets during the connect
-        process).
-      
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-          Describes the connection to be established.
-        
details -
-      a{sv}
-      (String_Variant_Map)
-    

-          Additional details about the Connect process.
-        
Possible errors
org.freedesktop.NetworkManager.VPN.Error.StartingInProgress

-      The plugin is already starting, and another connect request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted

-      The plugin is already connected, and another connect request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress

-      The plugin is already stopping, and another stop request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.BadArguments

-      The request could not be processed because it contained malformed
-      arguments, or arguments of unexpected type. It usually means that one of
-      the VPN setting data items or secrets was not of the expected type (i.e.
-      int, string, bool, etc).
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.LaunchFailed

-      A binary providing the service failed to launch.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.WrongState

-      The request could not be processed because the VPN plugin is in the wrong
-      state for this type of request.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported

-      The request could not be processed because the plugin does not support
-      interactive operations, such as ConnectInteractive() or NewSecrets().
-    (generic description)
NeedSecrets (
-        a{sa{sv}}: settings
-        ) →
-        s

-        Asks the plugin whether the provided connection will require secrets to connect successfully.
-      
Parameters
settings -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-          Describes the connection that may need secrets.
-        
Returns
setting_name -
-      s

-          The setting name within the provided connection that requires secrets, if any.
-        
Possible errors
org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid

-      The request could not be processed because the connection was invalid. It
-      usually means that the connection's VPN setting was missing some required
-      data item or secret.
-    (generic description)
Disconnect (
-        
-        ) →
-        nothing

-        Disconnect the plugin.
-      
Possible errors
org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress

-      The plugin is already stopping, and another stop request was received.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped

-      The plugin is already stopped, and another disconnect request was received.
-    (generic description)
SetConfig (
-        a{sv}: config
-        ) →
-        nothing

-        Set generic connection details on the connection.
-      
Parameters
config -
-      a{sv}
-      (String_Variant_Map)
-    

-          Generic configuration details for the connection.
-        
SetIp4Config (
-        a{sv}: config
-        ) →
-        nothing

-        Set IPv4 details on the connection.
-      
Parameters
config -
-      a{sv}
-      (String_Variant_Map)
-    

-          Ip4Config details for the connection. You must call
-	  SetConfig() before calling this.
-        
SetIp6Config (
-        a{sv}: config
-        ) →
-        nothing

-        Set IPv6 details on the connection.
-      
Parameters
config -
-      a{sv}
-      (String_Variant_Map)
-    

-          Ip6Config details for the connection. You must call
-	  SetConfig() before calling this.
-        
SetFailure (
-        s: reason
-        ) →
-        nothing

-        Indicate a failure to the plugin.
-      
Parameters
reason -
-      s

-          The reason for the failure.
-        
NewSecrets (
-        a{sa{sv}}: connection
-        ) →
-        nothing

-        Called in response to a SecretsRequired signal to deliver updated secrets
-        or other information to the plugin.
-      
Parameters
connection -
-      a{sa{sv}}
-      (String_String_Variant_Map_Map)
-    

-          Describes the connection including the new secrets.
-        
Possible errors
org.freedesktop.NetworkManager.VPN.Error.WrongState

-      The request could not be processed because the VPN plugin is in the wrong
-      state for this type of request.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.BadArguments

-      The request could not be processed because it contained malformed
-      arguments, or arguments of unexpected type. It usually means that one of
-      the VPN setting data items or secrets was not of the expected type (i.e.
-      int, string, bool, etc).
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.LaunchFailed

-      A binary providing the service failed to launch.
-    (generic description)
org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported

-      The request could not be processed because the plugin does not support
-      interactive operations, such as ConnectInteractive() or NewSecrets().
-    (generic description)
Signals:
StateChanged (
-        u: state
-        )

-        Emitted when the plugin state changes.
-      
Parameters
state -
-      u
-      (NM_VPN_SERVICE_STATE)
-    

-          The new state of the plugin.
-        
SecretsRequired (
-        s: message, as: secrets
-        )

-        Emitted during an ongoing ConnectInteractive() request when the plugin
-        has determined that new secrets are required.  NetworkManager will then
-        call the NewSecrets() method with a connection hash including the new
-        secrets.
-      
Parameters
message -
-      s

-              Informational message, if any, about the request.  For example, if
-              a second PIN is required, could indicate to the user to wait for
-              the token code to change until entering the next PIN.
-          
secrets -
-      as

-              Array of strings of VPN secret names which the plugin thinks
-              secrets may be required for, or other VPN-specific data to be
-              processed by the VPN's front-end.
-          
Config (
-        a{sv}: config
-        )

-        The plugin obtained generic configuration information.
-      
Parameters
config -
-      a{sv}
-      (String_Variant_Map)
-    

-          The configuration information.
-        
Ip4Config (
-        a{sv}: ip4config
-        )

-        The plugin obtained an IPv4 configuration.
-      
Parameters
ip4config -
-      a{sv}
-      (String_Variant_Map)
-    

-          The IPv4 configuration.
-        
Ip6Config (
-        a{sv}: ip6config
-        )

-        The plugin obtained an IPv6 configuration.
-      
Parameters
ip6config -
-      a{sv}
-      (String_Variant_Map)
-    

-          The IPv6 configuration.
-        
LoginBanner (
-        s: banner
-        )

-        Emitted when the plugin receives a login banner from the VPN service.
-      
Parameters
banner -
-      s

-          The login banner string.
-        
Failure (
-        u: reason
-        )

-        Emitted when a failure in the VPN plugin occurs.
-      
Parameters
reason -
-      u
-      (NM_VPN_PLUGIN_FAILURE)
-    

-          Reason code for the failure.
-        
Properties:
State -
-      u -
-      (read)
-      (NM_VPN_SERVICE_STATE)
-    

-        The state of the plugin.
-      
Enumerated types:
NM_VPN_SERVICE_STATE
NM_VPN_SERVICE_STATE_UNKNOWN = 0

-          The state of the VPN plugin is unknown.
-        
NM_VPN_SERVICE_STATE_INIT = 1

-          The VPN plugin is initialized.
-        
NM_VPN_SERVICE_STATE_SHUTDOWN = 2

-          (Not used.)
-        
NM_VPN_SERVICE_STATE_STARTING = 3

-          The plugin is attempting to connect to a VPN server.
-        
NM_VPN_SERVICE_STATE_STARTED = 4

-          The plugin has connected to a VPN server.
-        
NM_VPN_SERVICE_STATE_STOPPING = 5

-          The plugin is disconnecting from the VPN server.
-        
NM_VPN_SERVICE_STATE_STOPPED = 6

-          The plugin has disconnected from the VPN server.
-        
NM_VPN_PLUGIN_FAILURE
NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0

-          Login failed.
-        
NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1

-          Connect failed.
-        
NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG = 2

-          Invalid IP configuration returned from the VPN plugin.
-        

-
Generic types:
Enumerated types:
NM_802_11_MODE
NM_802_11_MODE_UNKNOWN = 0
Mode is unknown.
NM_802_11_MODE_ADHOC = 1

-        For both devices and access point objects, indicates the object is
-        part of an Ad-Hoc 802.11 network without a central coordinating access
-        point.
-      
NM_802_11_MODE_INFRA = 2

-        The wireless device or access point is in infrastructure mode.  For
-        devices, this indicates the device is an 802.11 client/station.  For
-        access point objects, this indicates the object is an access point that
-        provides connectivity to clients.
-      
NM_802_11_MODE_AP = 3

-        The device is an access point/hotspot.  Not valid for access point
-        objects themselves.
-      
Mapping types:
String_Variant_Map - a{
-        s: Key → v: Value
-        }
-      
A mapping from strings to variants representing extra
-      key-value pairs.
Members
Key -
-      s
(undocumented)
Value -
-      v
(undocumented)
String_String_Map - a{
-        s: Key → s: Value
-        }
-      
A mapping from strings to strings representing extra
-      key-value pairs.
Members
Key -
-      s
(undocumented)
Value -
-      s
(undocumented)
String_String_Variant_Map_Map - a{
-        s: Key → a{sv}: Value
-        }
-      
A mapping from strings to a map of string to variant.
Members
Key -
-      s
(undocumented)
Value -
-      a{sv}
-      (String_Variant_Map)
-    
(undocumented)
Errors:

-  
-
-  
org.freedesktop.NetworkManager.Error.UnknownConnection

-        Connection was not provided by the settings service.
-    
-
-  
org.freedesktop.NetworkManager.Error.UnknownDevice

-        Unknown device.
-    
-
-  
org.freedesktop.NetworkManager.Error.PermissionDenied

-    User does not have the permission to activate this connection.
-    
-
-
Errors:

-  
org.freedesktop.NetworkManager.VPN.Error.General
General failure without further details.
-  
org.freedesktop.NetworkManager.VPN.Error.StartingInProgress

-      The plugin is already starting, and another connect request was received.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted

-      The plugin is already connected, and another connect request was received.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress

-      The plugin is already stopping, and another stop request was received.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped

-      The plugin is already stopped, and another disconnect request was received.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.WrongState

-      The request could not be processed because the VPN plugin is in the wrong
-      state for this type of request.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.BadArguments

-      The request could not be processed because it contained malformed
-      arguments, or arguments of unexpected type. It usually means that one of
-      the VPN setting data items or secrets was not of the expected type (i.e.
-      int, string, bool, etc).
-    
-  
org.freedesktop.NetworkManager.VPN.Error.LaunchFailed

-      A binary providing the service failed to launch.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid

-      The request could not be processed because the connection was invalid. It
-      usually means that the connection's VPN setting was missing some required
-      data item or secret.
-    
-  
org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported

-      The request could not be processed because the plugin does not support
-      interactive operations, such as ConnectInteractive() or NewSecrets().
-    
-
Index
Index of interfaces
Index of types

\ No newline at end of file
+
+
+
+
+D-Bus API Reference: NetworkManager D-Bus API Reference Manual
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+

+D-Bus API Reference

+

+
Interfaces

+

+

+org.freedesktop.NetworkManager
+

+

+org.freedesktop.NetworkManager.Settings
+

+

+org.freedesktop.NetworkManager.AgentManager
+

+

+org.freedesktop.NetworkManager.AccessPoint
+

+

+org.freedesktop.NetworkManager.PPP
+

+

+org.freedesktop.NetworkManager.Settings.Connection
+

+

+org.freedesktop.NetworkManager.VPN.Connection
+

+

+org.freedesktop.NetworkManager.Connection.Active
+

+

+org.freedesktop.NetworkManager.Device
+

+

+org.freedesktop.NetworkManager.Device.Adsl
+

+

+org.freedesktop.NetworkManager.Device.Bond
+

+

+org.freedesktop.NetworkManager.Device.Bridge
+

+

+org.freedesktop.NetworkManager.Device.Bluetooth
+

+

+org.freedesktop.NetworkManager.Device.Wired
+

+

+org.freedesktop.NetworkManager.Device.Generic
+

+

+org.freedesktop.NetworkManager.Device.Infiniband
+

+

+org.freedesktop.NetworkManager.Device.IPTunnel
+

+

+org.freedesktop.NetworkManager.Device.Macvlan
+

+

+org.freedesktop.NetworkManager.Device.Modem
+

+

+org.freedesktop.NetworkManager.Device.OlpcMesh
+

+

+org.freedesktop.NetworkManager.Device.Team
+

+

+org.freedesktop.NetworkManager.Device.Tun
+

+

+org.freedesktop.NetworkManager.Device.Veth
+

+

+org.freedesktop.NetworkManager.Device.Vlan
+

+

+org.freedesktop.NetworkManager.Device.Vxlan
+

+

+org.freedesktop.NetworkManager.Device.Wireless
+

+

+org.freedesktop.NetworkManager.Device.WiMax
+

+

+org.freedesktop.NetworkManager.DHCP4Config
+

+

+org.freedesktop.NetworkManager.DHCP6Config
+

+

+org.freedesktop.NetworkManager.IP4Config
+

+

+org.freedesktop.NetworkManager.IP6Config
+

+

+org.freedesktop.NetworkManager.VPN.Plugin
+

+

+org.freedesktop.NetworkManager.SecretAgent
+

+

+

+

+      This part documents the D-Bus interface used to access the
+      NetworkManager daemon.
+    

+

+Interfaces

+

+

+
Generated by GTK-Doc V1.24

+
+
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5