diff options
| author | Michael Biebl <biebl@debian.org> | 2013-02-20 23:06:45 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2013-02-20 23:06:45 +0100 |
| commit | 8d275584fc94f398f0a7c990dcd057533d9a5856 (patch) | |
| tree | 1bf4a928e201222a008e6776799d174ee3223be3 /man | |
| parent | e17c5736fc3722ce51cb33f3edb203960125a4c1 (diff) | |
Imported Upstream version 0.9.8.0 upstream/0.9.8.0
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 28 | ||||
| -rw-r--r-- | man/Makefile.in | 95 | ||||
| -rw-r--r-- | man/NetworkManager.8 | 155 | ||||
| -rw-r--r-- | man/NetworkManager.8.in | 4 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 266 | ||||
| -rw-r--r-- | man/nm-online.1 | 63 | ||||
| -rw-r--r-- | man/nm-settings.5 | 2669 | ||||
| -rw-r--r-- | man/nm-settings.xml | 1687 | ||||
| -rw-r--r-- | man/nm-system-settings.conf.5 | 26 | ||||
| -rw-r--r-- | man/nm-tool.1 | 17 | ||||
| -rw-r--r-- | man/nm-tool.1.in | 2 | ||||
| -rw-r--r-- | man/nmcli.1 | 533 | ||||
| -rw-r--r-- | man/nmcli.1.in | 4 |
13 files changed, 35 insertions, 5514 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index a2d11ee0..d3512076 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,40 +1,26 @@ +man_MANS = +CLEANFILES = if ENABLE_DOC XSLTPROC = xsltproc --xinclude --nonet -GENERATED_FILES = nm-settings.xml nm-settings.5 - nm-settings.5: nm-settings.xml $(XSLTPROC) $(top_srcdir)/tools/manpages-docbook.xsl $(builddir)/nm-settings.xml +CLEANFILES += nm-settings.5 nm-settings.xml: $(top_builddir)/tools/generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la rm -f $(builddir)/$@ $(top_builddir)/tools/generate-settings-spec refentry $(builddir)/$@ +CLEANFILES += nm-settings.xml -else - -GENERATED_FILES = - -endif - -man_MANS = \ +man_MANS += \ NetworkManager.8 \ NetworkManager.conf.5 \ nm-system-settings.conf.5 \ nm-tool.1 \ nm-online.1 \ nmcli.1 \ - $(GENERATED_FILES) - -EXTRA_DIST = \ - $(man_MANS) \ - NetworkManager.8.in \ - NetworkManager.conf.5.in \ - nm-system-settings.conf.5.in \ - nm-tool.1.in \ - nm-online.1.in \ - nmcli.1.in - -CLEANFILES = $(man_MANS) $(GENERATED_FILES) + nm-settings.5 +endif diff --git a/man/Makefile.in b/man/Makefile.in index 982763f8..3dacf44b 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -50,6 +50,16 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ +@ENABLE_DOC_TRUE@am__append_1 = nm-settings.5 nm-settings.xml +@ENABLE_DOC_TRUE@am__append_2 = \ +@ENABLE_DOC_TRUE@ NetworkManager.8 \ +@ENABLE_DOC_TRUE@ NetworkManager.conf.5 \ +@ENABLE_DOC_TRUE@ nm-system-settings.conf.5 \ +@ENABLE_DOC_TRUE@ nm-tool.1 \ +@ENABLE_DOC_TRUE@ nm-online.1 \ +@ENABLE_DOC_TRUE@ nmcli.1 \ +@ENABLE_DOC_TRUE@ nm-settings.5 + subdir = man DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ $(srcdir)/NetworkManager.8.in \ @@ -118,10 +128,9 @@ am__uninstall_files_from_dir = { \ } man1dir = $(mandir)/man1 am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ - "$(DESTDIR)$(man8dir)" "$(DESTDIR)$(manxdir)" + "$(DESTDIR)$(man8dir)" man5dir = $(mandir)/man5 man8dir = $(mandir)/man8 -manxdir = $(mandir)/manx NROFF = nroff MANS = $(man_MANS) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) @@ -362,28 +371,9 @@ with_dhclient = @with_dhclient@ with_dhcpcd = @with_dhcpcd@ with_netconfig = @with_netconfig@ with_resolvconf = @with_resolvconf@ +man_MANS = $(am__append_2) +CLEANFILES = $(am__append_1) @ENABLE_DOC_TRUE@XSLTPROC = xsltproc --xinclude --nonet -@ENABLE_DOC_FALSE@GENERATED_FILES = -@ENABLE_DOC_TRUE@GENERATED_FILES = nm-settings.xml nm-settings.5 -man_MANS = \ - NetworkManager.8 \ - NetworkManager.conf.5 \ - nm-system-settings.conf.5 \ - nm-tool.1 \ - nm-online.1 \ - nmcli.1 \ - $(GENERATED_FILES) - -EXTRA_DIST = \ - $(man_MANS) \ - NetworkManager.8.in \ - NetworkManager.conf.5.in \ - nm-system-settings.conf.5.in \ - nm-tool.1.in \ - nm-online.1.in \ - nmcli.1.in - -CLEANFILES = $(man_MANS) $(GENERATED_FILES) all: all-am .SUFFIXES: @@ -564,49 +554,6 @@ uninstall-man8: } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ dir='$(DESTDIR)$(man8dir)'; $(am__uninstall_files_from_dir) -install-manx: $(man_MANS) - @$(NORMAL_INSTALL) - @list1=''; \ - list2='$(man_MANS)'; \ - test -n "$(manxdir)" \ - && test -n "`echo $$list1$$list2`" \ - || exit 0; \ - echo " $(MKDIR_P) '$(DESTDIR)$(manxdir)'"; \ - $(MKDIR_P) "$(DESTDIR)$(manxdir)" || exit 1; \ - { for i in $$list1; do echo "$$i"; done; \ - if test -n "$$list2"; then \ - for i in $$list2; do echo "$$i"; done \ - | sed -n '/\.x[a-z]*$$/p'; \ - fi; \ - } | while read p; do \ - if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ - echo "$$d$$p"; echo "$$p"; \ - done | \ - sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^x][0-9a-z]*$$,x,;x' \ - -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ - sed 'N;N;s,\n, ,g' | { \ - list=; while read file base inst; do \ - if test "$$base" = "$$inst"; then list="$$list $$file"; else \ - echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(manxdir)/$$inst'"; \ - $(INSTALL_DATA) "$$file" "$(DESTDIR)$(manxdir)/$$inst" || exit $$?; \ - fi; \ - done; \ - for i in $$list; do echo "$$i"; done | $(am__base_list) | \ - while read files; do \ - test -z "$$files" || { \ - echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(manxdir)'"; \ - $(INSTALL_DATA) $$files "$(DESTDIR)$(manxdir)" || exit $$?; }; \ - done; } - -uninstall-manx: - @$(NORMAL_UNINSTALL) - @list=''; test -n "$(manxdir)" || exit 0; \ - files=`{ for i in $$list; do echo "$$i"; done; \ - l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ - sed -n '/\.x[a-z]*$$/p'; \ - } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^x][0-9a-z]*$$,x,;x' \ - -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ - dir='$(DESTDIR)$(manxdir)'; $(am__uninstall_files_from_dir) tags: TAGS TAGS: @@ -661,7 +608,7 @@ check-am: all-am check: check-am all-am: Makefile $(MANS) installdirs: - for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man8dir)" "$(DESTDIR)$(manxdir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man8dir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -731,7 +678,7 @@ install-info: install-info-am install-info-am: -install-man: install-man1 install-man5 install-man8 install-manx +install-man: install-man1 install-man5 install-man8 install-pdf: install-pdf-am @@ -761,8 +708,7 @@ ps-am: uninstall-am: uninstall-man -uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 \ - uninstall-manx +uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 .MAKE: install-am install-strip @@ -772,13 +718,12 @@ uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 \ install-data install-data-am install-dvi install-dvi-am \ install-exec install-exec-am install-html install-html-am \ install-info install-info-am install-man install-man1 \ - install-man5 install-man8 install-manx install-pdf \ - install-pdf-am install-ps install-ps-am install-strip \ - installcheck installcheck-am installdirs maintainer-clean \ + install-man5 install-man8 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-generic \ mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ - uninstall-man uninstall-man1 uninstall-man5 uninstall-man8 \ - uninstall-manx + uninstall-man uninstall-man1 uninstall-man5 uninstall-man8 @ENABLE_DOC_TRUE@nm-settings.5: nm-settings.xml diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 deleted file mode 100644 index 87b5d69f..00000000 --- a/man/NetworkManager.8 +++ /dev/null @@ -1,155 +0,0 @@ -.\" NetworkManager(8) manual page -.\" -.\" Copyright (C) 2005 - 2013 Red Hat, Inc. -.\" Copyright (C) 2005 - 2009 Novell, Inc. -.\" Copyright (C) 2005 Robert Love -.\" -.TH NETWORKMANAGER "8" "17 January 2012" -.SH NAME -NetworkManager \- network management daemon -.SH SYNOPSIS -.B NetworkManager [\-\-version] | [\-\-help] -.PP -.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...] [\-\-log\-level=<level>] [\-\-log\-domains=<domain1>,<domain2>,...] [\-\-connectivity\-uri=<uri>] [\-\-connectivity\-interval=<int>] [\-\-connectivity\-response=<resp>] -.SH DESCRIPTION -The \fINetworkManager\fP 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. -.P -NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher.d -directory in alphabetical order in response to network events. Each script -should be: -.IP "(a)" 4 -a regular file -.IP "(b)" 4 -owned by root -.IP "(c)" 4 -not writable by group or other -.IP "(d)" 4 -not set-uid -.IP "(e)" 4 -and executable by the owner -.PP -Each script receives two arguments, the first being the interface name of the -device just activated, and second an action. -.PP -Actions: -.TP -.I "up" -The interface has been activated. The environment contains more information -about the interface; CONNECTION_UUID contains the UUID of the connection. Other -variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses \- 1), -in the format "address/prefix gateway". IP4_NUM_ADDRESSES contains the number -addresses the script may expect. IP4_NAMESERVERS contains a space-separated -list of the DNS servers, and IP4_DOMAINS contains a space-separated list of the -search domains. Routes use the format IP4_ROUTE_N where N is a number from 0 -to (# IPv4 routes \- 1), in the format "address/prefix next-hop metric", and -IP4_NUM_ROUTES contains the number of routes to expect. 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". -.TP -.I "down" -The interface has been deactivated. -.TP -.I "vpn\-up" -A VPN connection has been activated. The environment contains the connection -UUID in the variable CONNECTION_UUID. -.TP -.I "vpn\-down" -A VPN connection has been deactivated. -.TP -.I "hostname" -The system hostname has been updated. Use gethostname(2) to retrieve it. -.TP -.I "dhcp4\-change" -The DHCPv4 lease has changed (renewed, rebound, etc). -.TP -.I "dhcp6\-change" -The DHCPv6 lease has changed (renewed, rebound, etc). -.SH OPTIONS -The following options are supported: -.TP -.I "\-\-version" -Print the NetworkManager software version and exit. -.TP -.I "\-\-help" -Print NetworkManager's available options and exit. -.TP -.I "\-\-no\-daemon" -Do not daemonize. This is useful for debugging, and directs log output to the -controlling terminal in addition to syslog. -.TP -.I "\-\-pid\-file=<filename>" -Specify location of a PID file. The PID file is used for storing PID of the -running proccess and prevents running multiple instances. -.TP -.I "\-\-state\-file=<filename>" -Specify file for storing state of the NetworkManager persistently. If not specified, -the default value of '<LOCALSTATEDIR>/lib/NetworkManager/NetworkManager.state' is -used; where <LOCALSTATEDIR> is dependent on your distribution (usually it's /var). -.TP -.I "\-\-config=<filename>" -Specify configuration file to set up various settings for NetworkManager. If not -specified, the default value of '<SYSCONFDIR>/NetworkManager/NetworkManager.conf' -is used with a fallback to the older 'nm\-system\-settings.conf' if located in -the same directory; where <SYSCONFDIR> is dependent on your distribution (usually -it's /etc). See \fBNetworkManager.conf\fP(5) for more information on configuration -file. -.TP -.I "\-\-plugins=<plugin1>,<plugin2>, ... -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. -See \fBNetworkManager.conf\fP(5) for more information on the plugins. -.TP -.I "\-\-log\-level=<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 \fBNetworkManager.conf\fP(5) for more information on -log levels and domains. -.TP -.I "\-\-log\-domains=<domain1>,<domain2>, ... -Sets which operations are logged to the log destination (usually syslog). By -default, most domains are logging-enabled. See \fBNetworkManager.conf\fP(5) for -more information on log levels and domains. -.TP -.I "\-\-connectivity\-uri=<uri> -Sets the URI of a web page that will be used for connectivity checking. By -default connectivity checking is disabled. See \fBNetworkManager.conf\fP(5) -[connectivity] section for more information on connectivity checking feature. -.TP -.I "\-\-connectivity\-interval=<int> -Sets the interval (in seconds) in which connection checks for the URI are done. -0 means no checks. The default value is 300 seconds. See -\fBNetworkManager.conf\fP(5) [connectivity] section for more information on -connectivity checking feature. -.TP -.I "\-\-connectivity\-response=<resp> -If set, it controls what body content NetworkManager checks for when requesting -the URI for connectivity checking. If missing, defaults to "NetworkManager is online". -See \fBNetworkManager.conf\fP(5) [connectivity] section for more information on -connectivity checking feature. - -.SH 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. -.TP -.I "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. -.SH SEE ALSO -.BR nm\-tool (1), -.BR nm\-online (1), -.BR nmcli (1), -.BR NetworkManager.conf (5), -.BR nm\-settings (5). - diff --git a/man/NetworkManager.8.in b/man/NetworkManager.8.in index 87b5d69f..d550079a 100644 --- a/man/NetworkManager.8.in +++ b/man/NetworkManager.8.in @@ -151,5 +151,7 @@ which logs all PPP and PPTP frames and client/server exchanges. .BR nm\-online (1), .BR nmcli (1), .BR NetworkManager.conf (5), -.BR nm\-settings (5). +.BR nm\-settings (5), +.BR nm\-applet (1), +.BR nm\-connection\-editor (1). diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 deleted file mode 100644 index e595076a..00000000 --- a/man/NetworkManager.conf.5 +++ /dev/null @@ -1,266 +0,0 @@ -.\" NetworkManager.conf(5) manual page -.\" -.\" Copyright (C) 2010 - 2013 Red Hat, Inc. -.\" -.TH "NetworkManager.conf" "5" "17 January 2013" "" -.SH NAME -NetworkManager.conf \- NetworkManager configuration file -.SH SYNOPSIS -/etc/NetworkManager/NetworkManager.conf -.br -or -.br -\fI<SYSCONFDIR>\fP/NetworkManager/NetworkManager.conf -.br -where <SYSCONFDIR> depends on your distribution or build. -.SH DESCRIPTION -.P -.I NetworkManager.conf -is a configuration file for NetworkManager. It is used to set up various -aspects of NetworkManager's behavior. The location of -the file may be changed through use of the "\-\-config=" argument for -\fBNetworkManager\fP (8). -.SH "FILE FORMAT" -.P -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. -.br -Minimal system settings configuration file looks like this: -.P -.nf -[main] -plugins=keyfile -.fi -.P -Description of sections and available keys follows: -.SS [main] -This section is the only mandatory section of the configuration file. -.TP -.B plugins=\fIplugin1\fP,\fIplugin2\fP, ... -List system settings plugin names separated by ','. These plugins are used to -read/write system-wide connection. When more 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. If none of the plugins can save the -connection, the error is returned to the user. -.P -.RS -.B "Available plugins:" -.br -.TP -.I 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. For security, it will ignore files -that are readable or writeable by any user or group other than -.I root -since private keys and passphrases may be stored in plaintext inside the file. -.TP -.I ifcfg\-rh -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 wired, WiFi, and 802.1x connections, but does not yet support reading -or writing mobile broadband, PPPoE, or VPN connections. To allow reading and writing of these -add \fIkeyfile\fP plugin to your configuration as well. -.TP -.I ifupdown -plugin is used on the Debian and Ubuntu distributions, and reads connections from -/etc/network/interfaces. Since it cannot write connections out (that support isn't planned), -it is usually paired with the \fIkeyfile\fP plugin to enable saving and editing of new connections. -The \fIifupdown\fP plugin supports basic wired and WiFi connections, including WPA-PSK. -.TP -.I ifcfg\-suse -plugin is only provided for simple backward compatibility with SUSE and OpenSUSE configuration. -Most setups should be using the \fIkeyfile\fP plugin instead. The \fIifcfg\-suse\fP plugin supports -reading wired and WiFi connections, but does not support saving any connection types. -.RE -.TP -.B dhcp=\fIdhclient\fP | \fIdhcpcd\fP -This key sets up what DHCP client NetworkManager will use. Presently -\fIdhclient\fP and \fIdhcpcd\fP are supported. The client configured here should -be available on your system too. If this key is missing, available DHCP clients -are looked for in this order: dhclient, dhcpcd. -.TP -.B no-auto-default=\fI<hwaddr>\fP,\fI<hwaddr>\fP,... | \fI*\fP -Set devices for which NetworkManager shouldn't create default wired connection -(Auto eth0). NetworkManager creates a default wired connection for any wired -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. -.br -When the default wired connection is deleted or saved to a new persistent connection -by a plugin, the MAC address of the wired device is automatically added to this list -to prevent creating the default connection for that device again. -Devices are specified by their MAC addresses, in lowercase. Multiple -entries are separated by commas. You can use the glob character \fI*\fP instead -of listing addresses to specify all devices. -.br -Examples: -.nf -no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee -no-auto-default=* -.fi -.TP -.B dns=\fIplugin1\fP,\fIplugin2\fP, ... -List DNS plugin names separated by ','. DNS plugins are used to provide local -caching nameserver functionality (which speeds up DNS queries) and to push -DNS data to applications that use it. -.P -.RS -.B "Available plugins:" -.br -.TP -.I dnsmasq -this plugin uses dnsmasq to provide local caching nameserver functionality. -.RE -.SS [keyfile] -This section contains keyfile-specific options and thus only has effect when using \fIkeyfile\fP plugin. -.TP -.B hostname=\fI<hostname>\fP -Set a persistent hostname when using the \fIkeyfile\fP plugin. -.TP -.B unmanaged-devices=\fImac:<hwaddr>\fP;\fImac:<hwaddr>\fP;... -Set devices that should be ignored by NetworkManager when using the \fIkeyfile\fP -plugin. Devices are specified in the following format: "mac:<hwaddr>", where -<hwaddr> is MAC address of the device to be ignored, in hex-digits-and-colons notation. -Multiple entries are separated by a semicolon. No spaces are allowed in the value. -.br -Example: -.nf -unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4 -.fi -.SS [ifupdown] -This section contains ifupdown-specific options and thus only has effect when using \fIifupdown\fP plugin. -.TP -.B managed=\fIfalse\fP | \fItrue\fP -Controls whether interfaces listed in the 'interfaces' file are managed by NetworkManager. -If set to \fItrue\fP, then interfaces listed in /etc/network/interfaces are managed by NetworkManager. -If set to \fIfalse\fP, 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. -When the option is missing, \fIfalse\fP value is taken as default. -.SS [logging] -This section controls NetworkManager's logging. Any settings here are -overridden by the \-\-log\-level and \-\-log\-domains command-line options. -.TP -.B level=\fI<level>\fP -One of [ERR, WARN, INFO, DEBUG]. 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. Subsequent levels also log all messages -from earlier levels; thus setting the log level to INFO also logs error and -warning messages. -.TP -.B domains=\fI<domain1>,<domain2>, ...\fP -The following log domains are available: [HW, 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]. -.br -In addition to them, these special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. -.PP -.RS -NONE = when given by itself, logging is disabled -.br -ALL = all log domains will be switched on -.br -DEFAULT = default log domains -.br -DHCP = a shortcut for "DHCP4, DHCP6" -.br -IP = a shortcut for "IP4, IP6" -.br -.PP -HW = Hardware related operations -.br -RFKILL = RFKill subsystem operations -.br -ETHER = Ethernet device operations -.br -WIFI = Wi-Fi device operations -.br -BT = Bluetooth -.br -MB = Mobile Broadband -.br -DHCP4 = DHCP for IPv4 -.br -DHCP6 = DHCP for IPv6 -.br -PPP = Point-to-point protocol operations -.br -WIFI_SCAN = Wi-Fi scanning operations -.br -IP4 = Domain for IPv4 logging -.br -IP6 = Domain for IPv6 logging -.br -AUTOIP4 = AutoIP (avahi) operations -.br -DNS = Domain Name System related operations -.br -VPN = Virtual Private Network connections and operaions -.br -SHARING = Connection sharing -.br -SUPPLICANT = WPA supplicant related operations -.br -AGENTS = Secret agents operations and communication -.br -SETTINGS = Settings/config service operations -.br -SUSPEND = Suspend/resume -.br -CORE = Core daemon operations -.br -DEVICE = Activation and general interface operations -.br -OLPC = OLPC Mesh device operations -.br -WIMAX = Wimax device operations -.br -INFINIBAND = InfiniBand device operations -.br -FIREWALL = FirewallD related operations -.br -ADSL = ADSL device operations -.br -BOND = Bonding device operations -.br -VLAN = VLAN device operations -.br -BRIDGE = Bridging device operations -.br -.SS [connectivity] -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. -.TP -.B uri=\fI<uri>\fP -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 \fIresponse\fP -option. If this option is blank or missing, connectivity checking is disabled. -.TP -.B interval=\fI<seconds>\fP -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. -.TP -.B response=\fI<response>\fP -If set controls what body content NetworkManager checks for when requesting the -URI for connectivity checking. If missing, defaults to "NetworkManager is online" -.SH "SEE ALSO" -.BR http://live.gnome.org/NetworkManager/SystemSettings -.sp -.BR NetworkManager (8), -.BR nmcli (1), -.BR nm\-tool (1), -.BR nm\-online (1), -.BR nm\-settings (5). diff --git a/man/nm-online.1 b/man/nm-online.1 deleted file mode 100644 index 4859ba90..00000000 --- a/man/nm-online.1 +++ /dev/null @@ -1,63 +0,0 @@ -.\" nm-online (1) manual page -.\" -.\" This is free documentation; 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. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual 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 General Public Licence along -.\" with this manual; if not, write to the Free Software Foundation, Inc., -.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" -.\" Copyright (C) 2010 Red Hat, Inc. -.\" -.TH NM-ONLINE "1" "6 August 2010" - -.SH NAME -nm-online \- ask NetworkManager whether the network is connected -.SH SYNOPSIS -.B nm-online -.RI " [ " OPTIONS " ] - -.SH DESCRIPTION -.B nm-online -is a utility to find out whether we are online. It is done by asking -NetworkManager about its status. When run, \fInm\-online\fP waits until -NetworkManager reports an active connection, or specified timeout expires. On -exit, the returned status code should be checked (see the return codes bellow). - -.SH OPTIONS -.TP -.B \-t, \-\-timeout -Time to wait for a connection, in seconds. If not specified, the default is 30 -seconds. -.TP -.B \-x, \-\-exit -Exit immediately if NetworkManager is not running or connecting. -.TP -.B \-q, \-\-quiet -Don't print anything. - -.SH EXIT STATUS - -.IP "0" 4 -Success - already online or connection established within given timeout -.IP "1" 4 -Offline or not online within given timeout -.IP "2" 4 -Unspecified error - -.SH SEE ALSO -.BR nm\-tool (1), -.BR nmcli (1), -.BR NetworkManager(8). diff --git a/man/nm-settings.5 b/man/nm-settings.5 deleted file mode 100644 index 86e8cd52..00000000 --- a/man/nm-settings.5 +++ /dev/null @@ -1,2669 +0,0 @@ -'\" t -.\" Title: nm-settings -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> -.\" Date: 08 February 2013 -.\" Manual: Configuration -.\" Source: NetworkManager 0.9.7.997 -.\" Language: English -.\" -.TH "NM\-SETTINGS" "5" "08 February 2013" "NetworkManager 0\&.9\&.7\&.997" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-settings \- Description of settings and parameters of NetworkManager connections\&. -.SH "DESCRIPTION" -.PP -NetworkManager is based on a concept of connections\&. These connections are then applied to a device to make an active network connection\&. Users can create as many connections as they see fit\&. The connections are handled by NetworkManager via -\fIsettings service\fR -and are exported on D\-Bus (\fI/org/freedesktop/NetworkManager/Settings/<num>\fR -objects)\&. The conceptual objects can be described as follows: -.PP -Connection -.RS 4 -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 -\fISettings\fR -objects\&. -.RE -.PP -Setting -.RS 4 -A group of related key/value pairs describing a specific piece of a -\fIConnection\fR\&. Settings keys and allowed values are described in the tables below\&. Developers can find the settings objects in the libnm\-util sources\&. Look for the -\fBclass_init\fR -functions near the bottoms of each setting source file\&. -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&802-1x setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -802\-1x -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -eap -T}:T{ -array of string -T}:T{ -[] -T}:T{ -The allowed EAP method to be used when authenticating to the network with 802\&.1x\&. Valid methods are: \*(Aqleap\*(Aq, \*(Aqmd5\*(Aq, \*(Aqtls\*(Aq, \*(Aqpeap\*(Aq, \*(Aqttls\*(Aq, and \*(Aqfast\*(Aq\&. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations\&. -T} -T{ -identity -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. -T} -T{ -anonymous\-identity -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. -T} -T{ -pac\-file -T}:T{ -string -T}:T{ -\ \& -T}:T{ -UTF\-8 encoded file path containing PAC for EAP\-FAST\&. -T} -T{ -ca\-cert -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the CA certificate if used by the EAP method specified in the \*(Aqeap\*(Aq property\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. -T} -T{ -ca\-path -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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 \*(Aqca\-cert\*(Aq property\&. -T} -T{ -subject\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. -T} -T{ -altsubject\-matches -T}:T{ -array of string -T}:T{ -[] -T}:T{ -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\*(Aqs altSubjectName is performed\&. -T} -T{ -client\-cert -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the client certificate if used by the EAP method specified in the \*(Aqeap\*(Aq property\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. -T} -T{ -phase1\-peapver -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Forces which PEAP version is used when PEAP is set as the EAP method in \*(Aqeap\*(Aq 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 \*(Aq0\*(Aq or \*(Aq1\*(Aq to force that specific PEAP version\&. -T} -T{ -phase1\-peaplabel -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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 \*(Aq1\*(Aq to force use of the new PEAP label\&. See the wpa_supplicant documentation for more details\&. -T} -T{ -phase1\-fast\-provisioning -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Enables or disables in\-line provisioning of EAP\-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property\&. Allowed values are \*(Aq0\*(Aq (disabled), \*(Aq1\*(Aq (allow unauthenticated provisioning), \*(Aq2\*(Aq (allow authenticated provisioning), and \*(Aq3\*(Aq (allow both authenticated and unauthenticated provisioning)\&. See the wpa_supplicant documentation for more details\&. -T} -T{ -phase2\-auth -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specifies the allowed \*(Aqphase 2\*(Aq inner non\-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the \*(Aqeap\*(Aq property\&. Recognized non\-EAP phase2 methods are \*(Aqpap\*(Aq, \*(Aqchap\*(Aq, \*(Aqmschap\*(Aq, \*(Aqmschapv2\*(Aq, \*(Aqgtc\*(Aq, \*(Aqotp\*(Aq, \*(Aqmd5\*(Aq, and \*(Aqtls\*(Aq\&. Each \*(Aqphase 2\*(Aq inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. -T} -T{ -phase2\-autheap -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specifies the allowed \*(Aqphase 2\*(Aq inner EAP\-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the \*(Aqeap\*(Aq property\&. Recognized EAP\-based \*(Aqphase 2\*(Aq methods are \*(Aqmd5\*(Aq, \*(Aqmschapv2\*(Aq, \*(Aqotp\*(Aq, \*(Aqgtc\*(Aq, and \*(Aqtls\*(Aq\&. Each \*(Aqphase 2\*(Aq inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. -T} -T{ -phase2\-ca\-cert -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the \*(Aqphase 2\*(Aq CA certificate if used by the EAP method specified in the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq properties\&. Certificate data is specified using a \*(Aqscheme\*(Aq; two are currentlysupported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. -T} -T{ -phase2\-ca\-path -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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 \*(Aqphase2\-ca\-cert\*(Aq property\&. -T} -T{ -phase2\-subject\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server during the inner \*(Aqphase2\*(Aq authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. -T} -T{ -phase2\-altsubject\-matches -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of strings to be matched against List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner \*(Aqphase 2\*(Aq authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. -T} -T{ -phase2\-client\-cert -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the \*(Aqphase 2\*(Aq client certificate if used by the EAP method specified in the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq properties\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used for EAP authentication methods\&. -T} -T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the 802\&.1x password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -password\-raw -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Password used for EAP authentication methods as a byte array -T} -T{ -password\-raw\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the 802\&.1x password byte array\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -private\-key -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the private key when the \*(Aqeap\*(Aq property is set to \*(Aqtls\*(Aq\&. Key data is specified using a \*(Aqscheme\*(Aq; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the \*(Aqprivate\-key\-password\*(Aq property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string \*(Aqfile://\*(Aq and and ending with a terminating NULL byte, and as with the blob scheme the \*(Aqprivate\-key\-password\*(Aq property must be set to the password used to decode the PKCS#12 private key and certificate\&. -T} -T{ -private\-key\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to decrypt the private key specified in the \*(Aqprivate\-key\*(Aq property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key\&. -T} -T{ -private\-key\-password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the 802\&.1x private key password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -phase2\-private\-key -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Contains the \*(Aqphase 2\*(Aq inner private key when the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq property is set to \*(Aqtls\*(Aq\&. Key data is specified using a \*(Aqscheme\*(Aq; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the \*(Aqphase2\-private\-key\-password\*(Aq property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string \*(Aqfile://\*(Aq and and ending with a terminating NULL byte, and as with the blob scheme the \*(Aqphase2\-private\-key\-password\*(Aq property must be set to the password used to decode the PKCS#12 private key and certificate\&. -T} -T{ -phase2\-private\-key\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to decrypt the \*(Aqphase 2\*(Aq private key specified in the \*(Aqprivate\-key\*(Aq property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key\&. -T} -T{ -phase2\-private\-key\-password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the 802\&.1x phase2 private key password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -system\-ca\-certs -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When TRUE, overrides \*(Aqca\-path\*(Aq and \*(Aqphase2\-ca\-path\*(Aq 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 \*(Aqca\-cert\*(Aq and \*(Aqphase2\-ca\-cert\*(Aq properties\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&adsl setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -adsl -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the pppoa service\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the pppoa service\&. -T} -T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the ADSL password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -protocol -T}:T{ -string -T}:T{ -\ \& -T}:T{ -ADSL connection protocol\&. -T} -T{ -encapsulation -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Encapsulation of ADSL connection -T} -T{ -vpi -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -VPI of ADSL connection -T} -T{ -vci -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -VCI of ADSL connection -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&bluetooth setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -bluetooth -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -bdaddr -T}:T{ -byte array -T}:T{ -[] -T}:T{ -The Bluetooth address of the device -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Either \*(Aqdun\*(Aq for Dial\-Up Networking connections or \*(Aqpanu\*(Aq for Personal Area Networking connections\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&bond setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -bond -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The name of the virtual in\-kernel bonding network interface -T} -T{ -options -T}:T{ -dict of (string::string) -T}:T{ -[ ] -T}:T{ -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])\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&bridge setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -bridge -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The name of the virtual in\-kernel bridging network interface -T} -T{ -stp -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. -T} -T{ -priority -T}:T{ -uint32 -T}:T{ -128 -T}:T{ -Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are \*(Aqbetter\*(Aq; the lowest priority bridge will be elected the root bridge\&. -T} -T{ -forward\-delay -T}:T{ -uint32 -T}:T{ -15 -T}:T{ -The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. -T} -T{ -hello\-time -T}:T{ -uint32 -T}:T{ -2 -T}:T{ -The Spanning Tree Protocol (STP) hello time, in seconds\&. -T} -T{ -max\-age -T}:T{ -uint32 -T}:T{ -20 -T}:T{ -The Spanning Tree Protocol (STP) maximum message age, in seconds\&. -T} -T{ -ageing\-time -T}:T{ -uint32 -T}:T{ -300 -T}:T{ -The ethernet MAC address aging time, in seconds\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&bridge-port setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -bridge\-port -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -priority -T}:T{ -uint32 -T}:T{ -32 -T}:T{ -The Spanning Tree Protocol (STP) priority of this bridge port -T} -T{ -path\-cost -T}:T{ -uint32 -T}:T{ -100 -T}:T{ -The Spanning Tree Protocol (STP) port cost for destinations via this port\&. -T} -T{ -hairpin\-mode -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enables or disabled \*(Aqhairpin mode\*(Aq for the port, which allows frames to be sent back out through the port the frame was received on\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&cdma setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -cdma -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -number -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Number to dial when establishing a PPP data session with the CDMA\-based mobile broadband network\&. If not specified, the default number (#777) is used when required\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the network, if required\&. Note that many providers do not require a username or accept any username\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the network, if required\&. Note that many providers do not require a password or accept any password\&. -T} -T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the CDMA password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&connection setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -connection -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -User\-readable connection identifier/name\&. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it\&. -T} -T{ -uuid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Universally unique connection identifier\&. Must be in the format \*(Aq2815492f\-7e56\-435e\-b2e9\-246bd7cdc664\*(Aq (ie, contains only hexadecimal characters and \*(Aq\-\*(Aq)\&. The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the user changes the connection\*(Aqs \*(Aqid\*(Aq, but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Base type of the connection\&. For hardware\-dependent connections, should contain the setting name of the hardware\-type specific setting (ie, \*(Aq802\-3\-ethernet\*(Aq or \*(Aq802\-11\-wireless\*(Aq or \*(Aqbluetooth\*(Aq, etc), and for non\-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, \*(Aqvpn\*(Aq or \*(Aqbridge\*(Aq, etc)\&. -T} -T{ -permissions -T}:T{ -array of string -T}:T{ -[] -T}:T{ -An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection\&. Otherwise a user is allowed to access this connection if and only if they are in this array\&. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the \*(Aquser\*(Aq [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 \*(Aq:\*(Aq character\&. Any [reserved] information (if present) must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. -T} -T{ -autoconnect -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, NetworkManager will activate this connection when its network resources are available\&. If FALSE, the connection must be manually activated by the user or some other mechanism\&. -T} -T{ -timestamp -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated\&. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp\&. -T} -T{ -read\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the connection is read\-only and cannot be changed by the user or any other mechanism\&. This is normally set for system connections whose plugin cannot yet write updated connections back out\&. -T} -T{ -zone -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -master -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Interface name of the master device or UUID of the master connection -T} -T{ -slave\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Setting name describing the type of slave this connection is (ie, \*(Aqbond\*(Aq) or NULL if this connection is not a slave\&. -T} -T{ -secondaries -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of connection UUIDs that should be activated when the base connection itself is activated\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&gsm setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -gsm -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -number -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the network, if required\&. Note that many providers do not require a username or accept any username\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the network, if required\&. Note that many providers do not require a password or accept any password\&. -T} -T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the GSM password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -apn -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. -T} -T{ -network\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -network\-type -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Network preference to force the device to only use specific network technologies\&. The permitted values are: \-1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only\&. Note that not all devices allow network preference control\&. -T} -T{ -pin -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -pin\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the GSM SIM PIN\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -allowed\-bands -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -Bitfield of allowed frequency bands\&. Note that not all devices allow frequency band control\&. -T} -T{ -home\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&infiniband setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -infiniband -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -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)\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -T} -T{ -transport\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The IPoIB transport mode\&. Either \*(Aqdatagram\*(Aq or \*(Aqconnected\*(Aq\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&11.\ \&ipv4 setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -ipv4 -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -method -T}:T{ -string -T}:T{ -\ \& -T}:T{ -IPv4 configuration method\&. If \*(Aqauto\*(Aq is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset\&. If \*(Aqlink\-local\*(Aq is specified, then a link\-local address in the 169\&.254/16 range will be assigned to the interface\&. If \*(Aqmanual\*(Aq is specified, static IP addressing is used and at least one IP address must be given in the \*(Aqaddresses\*(Aq property\&. If \*(Aqshared\*(Aq is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10\&.42\&.x\&.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT\-ed to the current default network connection\&. \*(Aqdisabled\*(Aq means IPv4 will not be used on this connection\&. This property must be set\&. -T} -T{ -dns -T}:T{ -array of uint32 -T}:T{ -[] -T}:T{ -List of DNS servers (network byte order)\&. For the \*(Aqauto\*(Aq method, these DNS servers are appended to those (if any) returned by automatic configuration\&. DNS servers cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as there is no upstream network\&. In all other methods, these DNS servers are used as the only DNS servers for this connection\&. -T} -T{ -dns\-search -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of DNS search domains\&. For the \*(Aqauto\*(Aq method, these search domains are appended to those returned by automatic configuration\&. Search domains cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as there is no upstream network\&. In all other methods, these search domains are used as the only search domains for this connection\&. -T} -T{ -addresses -T}:T{ -array of array of uint32 -T}:T{ -[] -T}:T{ -Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. For the \*(Aqauto\*(Aq method, given IP addresses are appended to those returned by automatic configuration\&. Addresses cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as addressing is either automatic or disabled with these methods\&. -T} -T{ -routes -T}:T{ -array of array of uint32 -T}:T{ -[] -T}:T{ -Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. For the \*(Aqauto\*(Aq method, given IP routes are appended to those returned by automatic configuration\&. Routes cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq, methods as there is no upstream network\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When the method is set to \*(Aqauto\*(Aq and this property to TRUE, automatically configured routes are ignored and only routes specified in the \*(Aqroutes\*(Aq property, if any, are used\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When the method is set to \*(Aqauto\*(Aq and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the \*(Aqdns\*(Aq and \*(Aqdns\-search\*(Aq properties, if any, are used\&. -T} -T{ -dhcp\-client\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-send\-hostname -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the \*(Aqdhcp\-hostname\*(Aq property is empty and this property is TRUE, the current persistent hostname of the computer is sent\&. -T} -T{ -dhcp\-hostname -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If the \*(Aqdhcp\-send\-hostname\*(Aq property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. -T} -T{ -never\-default -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager\&. -T} -T{ -may\-fail -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&12.\ \&ipv6 setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -ipv6 -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -method -T}:T{ -string -T}:T{ -\ \& -T}:T{ -IPv6 configuration method\&. If \*(Aqauto\*(Aq is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset\&. To force the use of DHCP only, specify \*(Aqdhcp\*(Aq; this method is only valid for ethernet\-based hardware\&. If \*(Aqlink\-local\*(Aq is specified, then an IPv6 link\-local address will be assigned to the interface\&. If \*(Aqmanual\*(Aq is specified, static IP addressing is used and at least one IP address must be given in the \*(Aqaddresses\*(Aq property\&. If \*(Aqignored\*(Aq is specified, IPv6 configuration is not done\&. This property must be set\&. NOTE: the \*(Aqshared\*(Aq methodis not yet supported\&. -T} -T{ -dhcp\-hostname -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The specified name will be sent to the DHCP server when acquiring a lease\&. -T} -T{ -dns -T}:T{ -array of byte array -T}:T{ -[] -T}:T{ -Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order)\&. For the \*(Aqauto\*(Aq method, these DNS servers are appended to those (if any) returned by automatic configuration\&. DNS servers cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as there is no usptream network\&. In all other methods, these DNS servers are used as the only DNS servers for this connection\&. -T} -T{ -dns\-search -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of DNS search domains\&. For the \*(Aqauto\*(Aq method, these search domains are appended to those returned by automatic configuration\&. Search domains cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as there is no upstream network\&. In all other methods, these search domains are used as the only search domains for this connection\&. -T} -T{ -addresses -T}:T{ -array of (byte array, uint32, byte array) -T}:T{ -[] -T}:T{ -Array of IPv6 address structures\&. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32\-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any\&. If no gateway is given, the third element should be given as all zeros\&. For the \*(Aqauto\*(Aq method, given IP addresses are appended to those returned by automatic configuration\&. Addresses cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as the interface is automatically assigned an address with these methods\&. -T} -T{ -routes -T}:T{ -array of (byte array, uint32, byte array, uint32) -T}:T{ -[] -T}:T{ -Array of IPv6 route structures\&. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next\-hop IPv6 address (network byte order) if any, and the fourth being the route metric\&. For the \*(Aqauto\*(Aq method, given IP routes are appended to those returned by automatic configuration\&. Routes cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods because there is no upstream network\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When the method is set to \*(Aqauto\*(Aq or \*(Aqdhcp\*(Aq and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the \*(Aqroutes\*(Aq property, if any, are used\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When the method is set to \*(Aqauto\*(Aq or \*(Aqdhcp\*(Aq and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the \*(Aqdns\*(Aq and \*(Aqdns\-search\*(Aq properties, if any, are used\&. -T} -T{ -never\-default -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager\&. -T} -T{ -may\-fail -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv4\-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully\&. -T} -T{ -ip6\-privacy -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&13.\ \&802-11-olpc-mesh setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -802\-11\-olpc\-mesh -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -ssid -T}:T{ -byte array -T}:T{ -[] -T}:T{ -SSID of the mesh network to join\&. -T} -T{ -channel -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Channel on which the mesh network to join is located\&. -T} -T{ -dhcp\-anycast\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -Anycast DHCP MAC address used when requesting an IP address via DHCP\&. The specific anycast address used determines which DHCP server class answers the the request\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&14.\ \&ppp setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -ppp -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -noauth -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client\&. If FALSE, require authentication from the remote side\&. In almost all cases, this should be TRUE\&. -T} -T{ -refuse\-eap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the EAP authentication method will not be used\&. -T} -T{ -refuse\-pap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the PAP authentication method will not be used\&. -T} -T{ -refuse\-chap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the CHAP authentication method will not be used\&. -T} -T{ -refuse\-mschap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the MSCHAP authentication method will not be used\&. -T} -T{ -refuse\-mschapv2 -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the MSCHAPv2 authentication method will not be used\&. -T} -T{ -nobsdcomp -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, BSD compression will not be requested\&. -T} -T{ -nodeflate -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, \*(Aqdeflate\*(Aq compression will not be requested\&. -T} -T{ -no\-vj\-comp -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, Van Jacobsen TCP header compression will not be requested\&. -T} -T{ -require\-mppe -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. -T} -T{ -require\-mppe\-128 -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session, and the \*(Aqrequire\-mppe\*(Aq property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. -T} -T{ -mppe\-stateful -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. -T} -T{ -crtscts -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals\&. This value should normally be set to FALSE\&. -T} -T{ -baud -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to set the serial port to the specified baudrate\&. This value should normally be left as 0 to automatically choose the speed\&. -T} -T{ -mru -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to request that the peer send packets no larger than the specified size\&. If non\-zero, the MRU should be between 128 and 16384\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to send packets no larger than the specified size\&. -T} -T{ -lcp\-echo\-failure -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo\-requests go unanswered by the peer\&. The \*(Aqlcp\-echo\-interval\*(Aq property must also be set to a non\-zero value if this property is used\&. -T} -T{ -lcp\-echo\-interval -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to send an LCP echo\-request frame to the peer every n seconds (where n is the specified value)\&. Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&15.\ \&pppoe setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -pppoe -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -service -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce\&. For most providers, this should be left blank\&. It is only required if there are multiple access concentrators or a specific service is known to be required\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the PPPoE service\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the PPPoE service\&. -T} -T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the PPPoE password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&16.\ \&serial setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -serial -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -baud -T}:T{ -uint32 -T}:T{ -57600 -T}:T{ -Speed to use for communication over the serial port\&. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed\&. -T} -T{ -bits -T}:T{ -uint32 -T}:T{ -8 -T}:T{ -Byte\-width of the serial communication\&. The 8 in \*(Aq8n1\*(Aq for example\&. -T} -T{ -parity -T}:T{ -gchar -T}:T{ -110 -T}:T{ -Parity setting of the serial port\&. Either \*(AqE\*(Aq for even parity, \*(Aqo\*(Aq for odd parity, or \*(Aqn\*(Aq for no parity\&. -T} -T{ -stopbits -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in \*(Aq8n1\*(Aq for example\&. -T} -T{ -send\-delay -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -Time to delay between each byte sent to the modem, in microseconds\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&vlan setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -vlan -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the kernel name of the VLAN interface\&. If not given, a default name will be constructed from the interface described by the parent interface and the \*(Aqid\*(Aq property, ex \*(Aqeth2\&.1\*(Aq\&. The parent interface may be given by the \*(Aqparent\*(Aq property or by a hardware address property, eg the \*(Aqwired\*(Aq settings\*(Aq \*(Aqmac\-address\*(Aq property\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain a hardware address in a hardware\-specific setting, like the \*(Aqwired\*(Aq settings\*(Aq \*(Aqmac\-address\*(Aq property\&. -T} -T{ -id -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The VLAN indentifier the interface created by this connection should be assigned\&. -T} -T{ -flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -One or more flags which control the behavior and features of the VLAN interface\&. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device\*(Aqs operating state (0x04)\&. -T} -T{ -ingress\-priority\-map -T}:T{ -array of string -T}:T{ -[] -T}:T{ -For incoming packets, a list of mappings from 802\&.1p priorities to Linux SKB priorities\&. The mapping is given in the format \*(Aqfrom:to\*(Aq where both \*(Aqfrom\*(Aq and \*(Aqto\*(Aq are unsigned integers, ie \*(Aq7:3\*(Aq\&. -T} -T{ -egress\-priority\-map -T}:T{ -array of string -T}:T{ -[] -T}:T{ -For outgoing packets, a list of mappings from Linux SKB priorities to 802\&.1p priorities\&. The mapping is given in the format \*(Aqfrom:to\*(Aq where both \*(Aqfrom\*(Aq and \*(Aqto\*(Aq are unsigned integers, ie \*(Aq7:3\*(Aq\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&18.\ \&vpn setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -vpn -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -service\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -user\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -data -T}:T{ -dict of (string::string) -T}:T{ -[ ] -T}:T{ -Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. -T} -T{ -secrets -T}:T{ -dict of (string::string) -T}:T{ -[ ] -T}:T{ -Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&19.\ \&wimax setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -wimax -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -network\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -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)\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&20.\ \&802-3-ethernet setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -802\-3\-ethernet -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -port -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specific port type to use if multiple the device supports multiple attachment methods\&. One of \*(Aqtp\*(Aq (Twisted Pair), \*(Aqaui\*(Aq (Attachment Unit Interface), \*(Aqbnc\*(Aq (Thin Ethernet) or \*(Aqmii\*(Aq (Media Independent Interface\&. If the device supports only one port type, this setting is ignored\&. -T} -T{ -speed -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, request that the device use only the specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. -T} -T{ -duplex -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If specified, request that the device only use the specified duplex mode\&. Either \*(Aqhalf\*(Aq or \*(Aqfull\*(Aq\&. -T} -T{ -auto\-negotiate -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, allow auto\-negotiation of port speed and duplex mode\&. If FALSE, do not allow auto\-negotiation,in which case the \*(Aqspeed\*(Aq and \*(Aqduplex\*(Aq properties should be set\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -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)\&. -T} -T{ -cloned\-mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -If specified, request that the device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -array of string -T}:T{ -[] -T}:T{ -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)\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -T} -T{ -s390\-subchannels -T}:T{ -array of string -T}:T{ -[] -T}:T{ -Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host\&. Like the \*(Aqmac\-address\*(Aq 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\&. -T} -T{ -s390\-nettype -T}:T{ -string -T}:T{ -\ \& -T}:T{ -s390 network device type; one of \*(Aqqeth\*(Aq, \*(Aqlcs\*(Aq, or \*(Aqctc\*(Aq, representing the different types of virtual network devices available on s390 systems\&. -T} -T{ -s390\-options -T}:T{ -dict of (string::string) -T}:T{ -[ ] -T}:T{ -Dictionary of key/value pairs of s390\-specific device options\&. Both keys and values must be strings\&. Allowed keys include \*(Aqportno\*(Aq, \*(Aqlayer2\*(Aq, \*(Aqportname\*(Aq, \*(Aqprotocol\*(Aq, among others\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&21.\ \&802-11-wireless setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -802\-11\-wireless -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -ssid -T}:T{ -byte array -T}:T{ -[] -T}:T{ -SSID of the WiFi network\&. Must be specified\&. -T} -T{ -mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -WiFi network mode; one of \*(Aqinfrastructure\*(Aq, \*(Aqadhoc\*(Aq or \*(Aqap\*(Aq\&. If blank, infrastructure is assumed\&. -T} -T{ -band -T}:T{ -string -T}:T{ -\ \& -T}:T{ -802\&.11 frequency band of the network\&. One of \*(Aqa\*(Aq for 5GHz 802\&.11a or \*(Aqbg\*(Aq for 2\&.4GHz 802\&.11\&. This will lock associations to the WiFi network to the specific band, i\&.e\&. if \*(Aqa\*(Aq is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. -T} -T{ -channel -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Wireless channel to use for the WiFi connection\&. The device will only join (or create for Ad\-Hoc networks) a WiFi network on the specified channel\&. Because channel numbers overlap between bands, this property also requires the \*(Aqband\*(Aq property to be set\&. -T} -T{ -bssid -T}:T{ -byte array -T}:T{ -[] -T}:T{ -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\&. -T} -T{ -rate -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. -T} -T{ -tx\-power -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -If specified, this connection will only apply to the WiFi device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. -T} -T{ -cloned\-mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -If specified, request that the WiFi device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -array of string -T}:T{ -[] -T}:T{ -If specified, this connection will never apply to the WiFi 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)\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -T} -T{ -seen\-bssids -T}:T{ -array of string -T}:T{ -[] -T}:T{ -A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55\*(Aq) that have been detected as part of the WiFI network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BBSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. -T} -T{ -security -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If the wireless connection has any security restrictions, like 802\&.1x, WEP, or WPA, set this property to \*(Aq802\-11\-wireless\-security\*(Aq and ensure the connection contains a valid 802\-11\-wireless\-security setting\&. -T} -T{ -hidden -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, indicates this network is a non\-broadcasting network that hides its SSID\&. In this case various workarounds may take place, such as probe\-scanning the SSID for more reliable network discovery\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&22.\ \&802-11-wireless-security setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -name -T}:T{ -string -T}:T{ -802\-11\-wireless\-security -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ -key\-mgmt -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Key management used for the connection\&. One of \*(Aqnone\*(Aq (WEP), \*(Aqieee8021x\*(Aq (Dynamic WEP), \*(Aqwpa\-none\*(Aq (WPA\-PSK Ad\-Hoc), \*(Aqwpa\-psk\*(Aq (infrastructure WPA\-PSK), or \*(Aqwpa\-eap\*(Aq (WPA\-Enterprise)\&. This property must be set for any WiFi connection that uses security\&. -T} -T{ -wep\-tx\-keyidx -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -When static WEP is used (ie, key\-mgmt = \*(Aqnone\*(Aq) 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\&. -T} -T{ -auth\-alg -T}:T{ -string -T}:T{ -\ \& -T}:T{ -When WEP is used (ie, key\-mgmt = \*(Aqnone\*(Aq or \*(Aqieee8021x\*(Aq) indicate the 802\&.11 authentication algorithm required by the AP here\&. One of \*(Aqopen\*(Aq for Open System, \*(Aqshared\*(Aq for Shared Key, or \*(Aqleap\*(Aq for Cisco LEAP\&. When using Cisco LEAP (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq) the \*(Aqleap\-username\*(Aq and \*(Aqleap\-password\*(Aq properties must be specified\&. -T} -T{ -proto -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of strings specifying the allowed WPA protocol versions to use\&. Each element may be one \*(Aqwpa\*(Aq (allow WPA) or \*(Aqrsn\*(Aq (allow WPA2/RSN)\&. If not specified, both WPA and RSN connections are allowed\&. -T} -T{ -pairwise -T}:T{ -array of string -T}:T{ -[] -T}:T{ -If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities\&. Each element may be one of \*(Aqwep40\*(Aq, \*(Aqwep104\*(Aq, \*(Aqtkip\*(Aq, or \*(Aqccmp\*(Aq\&. -T} -T{ -group -T}:T{ -array of string -T}:T{ -[] -T}:T{ -If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities\&. Each element may be one of \*(Aqwep40\*(Aq, \*(Aqwep104\*(Aq, \*(Aqtkip\*(Aq, or \*(Aqccmp\*(Aq\&. -T} -T{ -leap\-username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The login username for legacy LEAP connections (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq)\&. -T} -T{ -wep\-key0 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 0 WEP key\&. This is the WEP key used in most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. -T} -T{ -wep\-key1 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 1 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. -T} -T{ -wep\-key2 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 2 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. -T} -T{ -wep\-key3 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 3 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. -T} -T{ -wep\-key\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the WEP keys\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -wep\-key\-type -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Controls the interpretation of WEP keys\&. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases)\&. If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length\&. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length\&. If set to 2, the passphrase is hashed using the de\-facto MD5 method to derive the actual WEP key\&. -T} -T{ -psk -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Pre\-Shared\-Key for WPA networks\&. If the key is 64\-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key\&. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802\&.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA\-PSK used when connecting to the WiFi network\&. -T} -T{ -psk\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the WPA PSK key\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -leap\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The login password for legacy LEAP connections (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq)\&. -T} -T{ -leap\-password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the LEAP password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -.TE -.sp 1 -.SS "Secret flag types:" -.PP -Each secret property in a setting has an associated -\fIflags\fR -property that describes how to handle that secret\&. The -\fIflags\fR -property is a bitfield that contains zero or more of the following values logically OR\-ed together\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x0 (none) \- the system is responsible for providing and storing this secret\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -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\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -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\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -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\&. -.RE -.SH "AUTHOR" -.PP - -NetworkManager developers -.SH "FILES" -.PP -/etc/NetworkManager/system\-connections -.PP -or distro plugin\-specific location -.SH "SEE ALSO" -.PP -https://live\&.gnome\&.org/NetworkManagerConfiguration -.PP -NetworkManager(8), nmcli(1), NetworkManager\&.conf(5) diff --git a/man/nm-settings.xml b/man/nm-settings.xml deleted file mode 100644 index 14f7a0f7..00000000 --- a/man/nm-settings.xml +++ /dev/null @@ -1,1687 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">]><refentry id="nm-settings"> - <refentryinfo> - <date>08 February 2013</date> - </refentryinfo> - <refmeta> - <refentrytitle>nm-settings</refentrytitle> - <manvolnum>5</manvolnum> - <refmiscinfo class="source">NetworkManager</refmiscinfo> - <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version">0.9.7.997</refmiscinfo> - </refmeta> - <refnamediv> - <refname>nm-settings</refname> - <refpurpose>Description of settings and parameters of NetworkManager connections.</refpurpose> - </refnamediv> - <refsect1> - <title>DESCRIPTION</title> - <para> - NetworkManager is based on a concept of connections. These connections are - then applied to a device to make an active network connection. Users can create - as many connections as they see fit. The connections are handled by NetworkManager - via <emphasis>settings service</emphasis> and are exported on D-Bus - (<emphasis>/org/freedesktop/NetworkManager/Settings/<num></emphasis> objects). - The conceptual objects can be described as follows: - <variablelist> - <varlistentry> - <term>Connection</term> - <listitem> - <para> - 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 <emphasis>Settings</emphasis> - objects. - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term>Setting</term> - <listitem> - <para> - A group of related key/value pairs describing a specific piece of a - <emphasis>Connection</emphasis>. Settings keys and allowed values are - described in the tables below. Developers can find the settings - objects in the libnm-util sources. Look for the <function>class_init</function> - functions near the bottoms of each setting source file. - </para> - </listitem> - </varlistentry> - </variablelist> -<table> - <title>802-1x setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-1x</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">eap</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry> - </row> - <row> - <entry align="left">identity</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry> - </row> - <row> - <entry align="left">anonymous-identity</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry> - </row> - <row> - <entry align="left">pac-file</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry> - </row> - <row> - <entry align="left">ca-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the CA certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry> - </row> - <row> - <entry align="left">ca-path</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'ca-cert' property.</entry> - </row> - <row> - <entry align="left">subject-match</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.</entry> - </row> - <row> - <entry align="left">altsubject-matches</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry> - </row> - <row> - <entry align="left">client-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the client certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</entry> - </row> - <row> - <entry align="left">phase1-peapver</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Forces which PEAP version is used when PEAP is set as the EAP method in 'eap' property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to '0' or '1' to force that specific PEAP version.</entry> - </row> - <row> - <entry align="left">phase1-peaplabel</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to '1' to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</entry> - </row> - <row> - <entry align="left">phase1-fast-provisioning</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed values are '0' (disabled), '1' (allow unauthenticated provisioning), '2' (allow authenticated provisioning), and '3' (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</entry> - </row> - <row> - <entry align="left">phase2-auth</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry> - </row> - <row> - <entry align="left">phase2-autheap</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized EAP-based 'phase 2' methods are 'md5', 'mschapv2', 'otp', 'gtc', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry> - </row> - <row> - <entry align="left">phase2-ca-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the 'phase 2' CA certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currentlysupported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry> - </row> - <row> - <entry align="left">phase2-ca-path</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'phase2-ca-cert' property.</entry> - </row> - <row> - <entry align="left">phase2-subject-match</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Substring to be matched against the subject of the certificate presented by the authentication server during the inner 'phase2' authentication. When unset, no verification of the authentication server certificate's subject is performed.</entry> - </row> - <row> - <entry align="left">phase2-altsubject-matches</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of strings to be matched against List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner 'phase 2' authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry> - </row> - <row> - <entry align="left">phase2-client-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the 'phase 2' client certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used for EAP authentication methods.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">password-raw</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Password used for EAP authentication methods as a byte array</entry> - </row> - <row> - <entry align="left">password-raw-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x password byte array. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">private-key</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the private key when the 'eap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</entry> - </row> - <row> - <entry align="left">private-key-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The password used to decrypt the private key specified in the 'private-key' property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</entry> - </row> - <row> - <entry align="left">private-key-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">phase2-private-key</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Contains the 'phase 2' inner private key when the 'phase2-auth' or 'phase2-autheap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'phase2-private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'phase2-private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</entry> - </row> - <row> - <entry align="left">phase2-private-key-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.</entry> - </row> - <row> - <entry align="left">phase2-private-key-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x phase2 private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">system-ca-certs</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When TRUE, overrides 'ca-path' and 'phase2-ca-path' properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the 'ca-cert' and 'phase2-ca-cert' properties.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>adsl setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">adsl</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the ADSL password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">protocol</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>ADSL connection protocol.</entry> - </row> - <row> - <entry align="left">encapsulation</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Encapsulation of ADSL connection</entry> - </row> - <row> - <entry align="left">vpi</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>VPI of ADSL connection</entry> - </row> - <row> - <entry align="left">vci</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>VCI of ADSL connection</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bluetooth setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bluetooth</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">bdaddr</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>The Bluetooth address of the device</entry> - </row> - <row> - <entry align="left">type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bond setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bond</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The name of the virtual in-kernel bonding network interface</entry> - </row> - <row> - <entry align="left">options</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bridge</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The name of the virtual in-kernel bridging network interface</entry> - </row> - <row> - <entry align="left">stp</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry> - </row> - <row> - <entry align="left">priority</entry> - <entry align="left">uint32</entry> - <entry align="left">128</entry> - <entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.</entry> - </row> - <row> - <entry align="left">forward-delay</entry> - <entry align="left">uint32</entry> - <entry align="left">15</entry> - <entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry> - </row> - <row> - <entry align="left">hello-time</entry> - <entry align="left">uint32</entry> - <entry align="left">2</entry> - <entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry> - </row> - <row> - <entry align="left">max-age</entry> - <entry align="left">uint32</entry> - <entry align="left">20</entry> - <entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry> - </row> - <row> - <entry align="left">ageing-time</entry> - <entry align="left">uint32</entry> - <entry align="left">300</entry> - <entry>The ethernet MAC address aging time, in seconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge-port setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bridge-port</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">priority</entry> - <entry align="left">uint32</entry> - <entry align="left">32</entry> - <entry>The Spanning Tree Protocol (STP) priority of this bridge port</entry> - </row> - <row> - <entry align="left">path-cost</entry> - <entry align="left">uint32</entry> - <entry align="left">100</entry> - <entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry> - </row> - <row> - <entry align="left">hairpin-mode</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>cdma setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">cdma</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">number</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the CDMA password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>connection setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">connection</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>User-readable connection identifier/name. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it.</entry> - </row> - <row> - <entry align="left">uuid</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes.</entry> - </row> - <row> - <entry align="left">type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, '802-3-ethernet' or '802-11-wireless' or 'bluetooth', etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, 'vpn' or 'bridge', etc).</entry> - </row> - <row> - <entry align="left">permissions</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this array. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the 'user' [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ':' character. Any [reserved] information (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry> - </row> - <row> - <entry align="left">autoconnect</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, NetworkManager will activate this connection when its network resources are available. If FALSE, the connection must be manually activated by the user or some other mechanism.</entry> - </row> - <row> - <entry align="left">timestamp</entry> - <entry align="left">uint64</entry> - <entry align="left">0</entry> - <entry>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</entry> - </row> - <row> - <entry align="left">read-only</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</entry> - </row> - <row> - <entry align="left">zone</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The trust level of a the connection.Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</entry> - </row> - <row> - <entry align="left">master</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Interface name of the master device or UUID of the master connection</entry> - </row> - <row> - <entry align="left">slave-type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</entry> - </row> - <row> - <entry align="left">secondaries</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of connection UUIDs that should be activated when the base connection itself is activated.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>gsm setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">gsm</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">number</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the GSM password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">apn</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry> - </row> - <row> - <entry align="left">network-id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry> - </row> - <row> - <entry align="left">network-type</entry> - <entry align="left">int32</entry> - <entry align="left">-1</entry> - <entry>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.</entry> - </row> - <row> - <entry align="left">pin</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</entry> - </row> - <row> - <entry align="left">pin-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the GSM SIM PIN. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">allowed-bands</entry> - <entry align="left">uint32</entry> - <entry align="left">1</entry> - <entry>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</entry> - </row> - <row> - <entry align="left">home-only</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>infiniband setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">infiniband</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry> - </row> - <row> - <entry align="left">transport-mode</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The IPoIB transport mode. Either 'datagram' or 'connected'.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv4 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ipv4</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">method</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.</entry> - </row> - <row> - <entry align="left">dns</entry> - <entry align="left">array of uint32</entry> - <entry align="left">[]</entry> - <entry>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> - </row> - <row> - <entry align="left">dns-search</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> - </row> - <row> - <entry align="left">addresses</entry> - <entry align="left">array of array of uint32</entry> - <entry align="left">[]</entry> - <entry>Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</entry> - </row> - <row> - <entry align="left">routes</entry> - <entry align="left">array of array of uint32</entry> - <entry align="left">[]</entry> - <entry>Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</entry> - </row> - <row> - <entry align="left">ignore-auto-routes</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When the method is set to 'auto' and this property to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</entry> - </row> - <row> - <entry align="left">ignore-auto-dns</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</entry> - </row> - <row> - <entry align="left">dhcp-client-id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.</entry> - </row> - <row> - <entry align="left">dhcp-send-hostname</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the 'dhcp-hostname' property is empty and this property is TRUE, the current persistent hostname of the computer is sent.</entry> - </row> - <row> - <entry align="left">dhcp-hostname</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry align="left">never-default</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</entry> - </row> - <row> - <entry align="left">may-fail</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv6 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ipv6</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">method</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignored' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</entry> - </row> - <row> - <entry align="left">dhcp-hostname</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry align="left">dns</entry> - <entry align="left">array of byte array</entry> - <entry align="left">[]</entry> - <entry>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> - </row> - <row> - <entry align="left">dns-search</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> - </row> - <row> - <entry align="left">addresses</entry> - <entry align="left">array of (byte array, uint32, byte array)</entry> - <entry align="left">[]</entry> - <entry>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</entry> - </row> - <row> - <entry align="left">routes</entry> - <entry align="left">array of (byte array, uint32, byte array, uint32)</entry> - <entry align="left">[]</entry> - <entry>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</entry> - </row> - <row> - <entry align="left">ignore-auto-routes</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</entry> - </row> - <row> - <entry align="left">ignore-auto-dns</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</entry> - </row> - <row> - <entry align="left">never-default</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</entry> - </row> - <row> - <entry align="left">may-fail</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</entry> - </row> - <row> - <entry align="left">ip6-privacy</entry> - <entry align="left">int32</entry> - <entry align="left">-1</entry> - <entry>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-olpc-mesh setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-olpc-mesh</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">ssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>SSID of the mesh network to join.</entry> - </row> - <row> - <entry align="left">channel</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Channel on which the mesh network to join is located.</entry> - </row> - <row> - <entry align="left">dhcp-anycast-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the the request.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ppp setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ppp</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">noauth</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</entry> - </row> - <row> - <entry align="left">refuse-eap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the EAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-pap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the PAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-chap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the CHAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-mschap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the MSCHAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-mschapv2</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry> - </row> - <row> - <entry align="left">nobsdcomp</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, BSD compression will not be requested.</entry> - </row> - <row> - <entry align="left">nodeflate</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, 'deflate' compression will not be requested.</entry> - </row> - <row> - <entry align="left">no-vj-comp</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry> - </row> - <row> - <entry align="left">require-mppe</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</entry> - </row> - <row> - <entry align="left">require-mppe-128</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the 'require-mppe' property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</entry> - </row> - <row> - <entry align="left">mppe-stateful</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry> - </row> - <row> - <entry align="left">crtscts</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</entry> - </row> - <row> - <entry align="left">baud</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</entry> - </row> - <row> - <entry align="left">mru</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry> - </row> - <row> - <entry align="left">lcp-echo-failure</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The 'lcp-echo-interval' property must also be set to a non-zero value if this property is used.</entry> - </row> - <row> - <entry align="left">lcp-echo-interval</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>pppoe setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">pppoe</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">service</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the PPPoE password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>serial setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">serial</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">baud</entry> - <entry align="left">uint32</entry> - <entry align="left">57600</entry> - <entry>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry> - </row> - <row> - <entry align="left">bits</entry> - <entry align="left">uint32</entry> - <entry align="left">8</entry> - <entry>Byte-width of the serial communication. The 8 in '8n1' for example.</entry> - </row> - <row> - <entry align="left">parity</entry> - <entry align="left">gchar</entry> - <entry align="left">110</entry> - <entry>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</entry> - </row> - <row> - <entry align="left">stopbits</entry> - <entry align="left">uint32</entry> - <entry align="left">1</entry> - <entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</entry> - </row> - <row> - <entry align="left">send-delay</entry> - <entry align="left">uint64</entry> - <entry align="left">0</entry> - <entry>Time to delay between each byte sent to the modem, in microseconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vlan setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">vlan</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' settings' 'mac-address' property.</entry> - </row> - <row> - <entry align="left">parent</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.</entry> - </row> - <row> - <entry align="left">id</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>The VLAN indentifier the interface created by this connection should be assigned.</entry> - </row> - <row> - <entry align="left">flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).</entry> - </row> - <row> - <entry align="left">ingress-priority-map</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry> - </row> - <row> - <entry align="left">egress-priority-map</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vpn setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">vpn</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">service-type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry> - </row> - <row> - <entry align="left">user-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry> - </row> - <row> - <entry align="left">data</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry> - </row> - <row> - <entry align="left">secrets</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>wimax setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">wimax</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">network-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-3-ethernet setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-3-ethernet</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">port</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Specific port type to use if multiple the device supports multiple attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. If the device supports only one port type, this setting is ignored.</entry> - </row> - <row> - <entry align="left">speed</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</entry> - </row> - <row> - <entry align="left">duplex</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</entry> - </row> - <row> - <entry align="left">auto-negotiate</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry> - </row> - <row> - <entry align="left">cloned-mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> - </row> - <row> - <entry align="left">mac-address-blacklist</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will never apply to the ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry align="left">s390-subchannels</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry> - </row> - <row> - <entry align="left">s390-nettype</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</entry> - </row> - <row> - <entry align="left">s390-options</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-wireless</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">ssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>SSID of the WiFi network. Must be specified.</entry> - </row> - <row> - <entry align="left">mode</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry> - </row> - <row> - <entry align="left">band</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry> - </row> - <row> - <entry align="left">channel</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</entry> - </row> - <row> - <entry align="left">bssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</entry> - </row> - <row> - <entry align="left">rate</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry> - </row> - <row> - <entry align="left">tx-power</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry> - </row> - <row> - <entry align="left">cloned-mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> - </row> - <row> - <entry align="left">mac-address-blacklist</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will never apply to the WiFi device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry align="left">seen-bssids</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the WiFI network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.</entry> - </row> - <row> - <entry align="left">security</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</entry> - </row> - <row> - <entry align="left">hidden</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless-security setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-wireless-security</entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry align="left">key-mgmt</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.</entry> - </row> - <row> - <entry align="left">wep-tx-keyidx</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry> - </row> - <row> - <entry align="left">auth-alg</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the 802.11 authentication algorithm required by the AP here. One of 'open' for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') the 'leap-username' and 'leap-password' properties must be specified.</entry> - </row> - <row> - <entry align="left">proto</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry> - </row> - <row> - <entry align="left">pairwise</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</entry> - </row> - <row> - <entry align="left">group</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</entry> - </row> - <row> - <entry align="left">leap-username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry align="left">wep-key0</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Index 0 WEP key. This is the WEP key used in most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</entry> - </row> - <row> - <entry align="left">wep-key1</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Index 1 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</entry> - </row> - <row> - <entry align="left">wep-key2</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Index 2 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</entry> - </row> - <row> - <entry align="left">wep-key3</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Index 3 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</entry> - </row> - <row> - <entry align="left">wep-key-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the WEP keys. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">wep-key-type</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.</entry> - </row> - <row> - <entry align="left">psk</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</entry> - </row> - <row> - <entry align="left">psk-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the WPA PSK key. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">leap-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry align="left">leap-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the LEAP password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> - </para> - <refsect2 id="secrets-flags"> - <title>Secret flag types:</title> - <para> - Each secret property in a setting has an associated <emphasis>flags</emphasis> property - that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield - that contains zero or more of the following values logically OR-ed together. - </para> - <itemizedlist> - <listitem> - <para>0x0 (none) - the system is responsible for providing and storing this secret.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - </itemizedlist> - </refsect2> - </refsect1> - <refsect1> - <title>AUTHOR</title> - <para> - <author> - <firstname>NetworkManager developers</firstname> - </author> - </para> - </refsect1> - <refsect1> - <title>FILES</title> - <para>/etc/NetworkManager/system-connections</para> - <para>or distro plugin-specific location</para> - </refsect1> - <refsect1> - <title>SEE ALSO</title> - <para>https://live.gnome.org/NetworkManagerConfiguration</para> - <para>NetworkManager(8), nmcli(1), NetworkManager.conf(5)</para> - </refsect1> -</refentry> diff --git a/man/nm-system-settings.conf.5 b/man/nm-system-settings.conf.5 deleted file mode 100644 index e48d0c8e..00000000 --- a/man/nm-system-settings.conf.5 +++ /dev/null @@ -1,26 +0,0 @@ -.\" nm-system-settings.conf(5) manual page -.\" -.\" Copyright (C) 2010 Red Hat, Inc. -.\" -.TH "nm-system-settings.conf" "5" "1 February 2010" "" -.SH NAME -nm\-system\-settings.conf \- Deprecated NetworkManager configuration file -.SH SYNOPSIS -/etc/NetworkManager/nm\-system\-settings.conf -.br -or -.br -\fI<SYSCONFDIR>\fP/NetworkManager/nm\-system\-settings.conf -.br -where <SYSCONFDIR> depends on your distribution or build. -.SH DESCRIPTION -.P -.I nm\-system\-settings.conf -is a deprecated configuration file for \fBNetworkManager\fP (5). While this -file can still be used, NetworkManager now defaults to reading the config -file <SYSCONFDIR>\fP/NetworkManager/NetworkManager.conf\fP instead, falling back -to nm\-system\-settings.conf if NetworkManager.conf does not exist. -.SH "SEE ALSO" -.BR NetworkManager (8), -.BR NetworkManager.conf (5), -.BR nm\-tool (1). diff --git a/man/nm-tool.1 b/man/nm-tool.1 deleted file mode 100644 index 168a5dc5..00000000 --- a/man/nm-tool.1 +++ /dev/null @@ -1,17 +0,0 @@ -.\" nm-tool(1) manual page -.\" -.\" Copyright (C) 2005 - 2009 Red Hat, Inc. -.\" Copyright (C) 2005 - 2009 Novell, Inc. -.\" Copyright (C) 2005 Robert Love -.\" -.TH NM-TOOL "1" -.SH NAME -nm-tool \- utility to report NetworkManager state and devices -.SH SYNOPSIS -.B nm-tool -.SH DESCRIPTION -The \fInm-tool\fP utility provides information about NetworkManager, device, -and wireless networks. -.SH SEE ALSO -.BR NetworkManager (8), - diff --git a/man/nm-tool.1.in b/man/nm-tool.1.in index 168a5dc5..0db23a20 100644 --- a/man/nm-tool.1.in +++ b/man/nm-tool.1.in @@ -14,4 +14,6 @@ The \fInm-tool\fP utility provides information about NetworkManager, device, and wireless networks. .SH SEE ALSO .BR NetworkManager (8), +.BR nm\-applet (1), +.BR nm\-connection\-editor (1). diff --git a/man/nmcli.1 b/man/nmcli.1 deleted file mode 100644 index d1f3a0ca..00000000 --- a/man/nmcli.1 +++ /dev/null @@ -1,533 +0,0 @@ -.\" nmcli (1) manual page -.\" -.\" This is free documentation; 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. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual 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 General Public Licence along -.\" with this manual; if not, write to the Free Software Foundation, Inc., -.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" -.\" Copyright (C) 2010 - 2013 Red Hat, Inc. -.\" -.TH NMCLI "1" "17 January 2013" - -.SH NAME -nmcli \(en command\(hyline tool for controlling NetworkManager -.SH SYNOPSIS -.ad l -.B nmcli -.RI " [ " OPTIONS " ] " OBJECT " { " COMMAND " | " -.BR help " } " -.sp - -.IR OBJECT " := { " -.BR nm " | " con " | " dev " } " -.sp - -.IR OPTIONS " := { " -.br -\fB\-t\fR[\fIerse\fR] -.br -\fB\-p\fR[\fIretty\fR] -.br -\fB\-m\fR[\fImode\fR] tabular | multiline -.br -\fB\-f\fR[\fIields\fR] <field1,field2,...> | all | common -.br -\fB\-e\fR[\fIscape\fR] yes | no -.br -\fB\-v\fR[\fIersion\fR] -.br -\fB\-h\fR[\fIelp\fR] -.br -.RI "}" - -.SH DESCRIPTION -.B nmcli -is a command\(hyline tool for controlling NetworkManager and reporting on its status. -It is not meant as a full replacement for \fInm\(hyapplet\fP or other similar clients -but as a complementary utility to those programs. -The main usage for \fInmcli\fP is on servers, headless machines or for power users -who prefer the command line. -.P -Typical applications include: -.IP \(em 4 -Initscripts: ifup/ifdown can utilize NetworkManager via \fInmcli\fP instead of -having to manage connections itself and possibly interfere with NetworkManager. -.IP \(em 4 -Servers, headless machines: No GUI is available; then \fInmcli\fP can be used -to activate/deactivate connections. However, if a connection requires a secret -in order to activate and if that secret is not stored at the system level, -\fInmcli\fP will not be able to activate it; it is currently unable to supply -the secrets to NetworkManager. -.IP \(em 4 -User sessions: \fInmcli\fP can be used to activate/deactivate connections from -the command line, but a client with a secret agent (like \fInm\(hyapplet\fP) is needed -for supplying secrets not stored at the system level. Keyring dialogs and -password prompts may appear if this happens. -.SS \fIOPTIONS\fP -.TP -.B \-t, \-\-terse -Output is terse. This mode is designed and suitable for computer (script) -processing. -.TP -.B \-p, \-\-pretty -Output is pretty. This causes \fInmcli\fP to produce easily readable outputs -for humans, i.e. values are aligned, headers are printed, etc. -.TP -.B \-m, \-\-mode tabular | multiline -Switch between \fItabular\fP and \fImultiline\fP output. -If omitted, default is \fItabular\fP for most commands. For the commands -producing more structured information, that cannot be displayed on a single -line, default is \fImultiline\fP. Currenly, they are: -.br -.nf - 'nmcli con list id|uuid <name>' - 'nmcli dev list' -.fi -\fItabular\fP \(en Output is a table where each line describes a single entry. -Columns define particular properties of the entry. -.br -\fImultiline\fP \(en Each entry comprises multiple lines, each property on its own -line. The values are prefixed with the property name. -.TP -.B \-f, \-\-fields <field1,field2,...> | all | common -This option is used to specify what fields (column names) should be printed. -Valid field names differ for specific commands. List available fields by -providing an invalid value to the \fI\-\-fields\fP option. -.br -\fIall\fP is used to print all valid field values of the command. -\fIcommon\fP is used to print common field values of the command. -If omitted, default is \fIcommon\fP. -The option is mandatory when \fI\-\-terse\fP is used. In this case, generic -values \fIall\fP and \fIcommon\fP cannot be used. (This is to maintain -compatibility when new fields are added in the future). -.TP -.B \-e, \-\-escape yes | no -Whether to escape ':' and '\\' characters in terse tabular mode. The escape -character is '\\'. -If omitted, default is \fIyes\fP. -.TP -.B \-v, \-\-version -Show \fInmcli\fP version. -.TP -.B \-h, \-\-help -Print help information. -.SS \fIOBJECT\fP -.TP -.B nm -NetworkManager -.br -Use this object to inquire and change state of NetworkManager. -.TP -.SS \fICOMMAND\fP := { status | permissions | enable | sleep | wifi | wwan | wimax } -.sp -.RS -.TP -.B status -.br -Show overall status of NetworkManager. This is the default action, when no -command is provided to \fInm\fP object. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B permissions -.br -Show the permissions a caller has for various authenticated operations that -NetworkManager provides, like enable/disable networking, changing Wi\(hyFi, WWAN, -and WiMAX state, modifying connections, etc. -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: GetPermissions -arguments: none -.fi -.TP -.B enable [true|false] -.br -Get networking\(hyenabled status or enable/disable networking by NetworkManager. -All interfaces managed by NetworkManager are deactivated when networking has -been disabled. -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: Enable -arguments: TRUE or FALSE -.fi -.TP -.B sleep [true|false] -.br -Get sleep status or put to sleep/awake NetworkManager. All interfaces managed -by NetworkManager are deactivated when it falls asleep. This command is not -meant for user to enable/disable networking, use \fIenable\fP for that. D\(hyBus -\fISleep\fP method is designed to put NetworkManager to sleep or awake for -suspending/resuming the computer. -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: Sleep -arguments: TRUE or FALSE -.fi -.TP -.B wifi [on|off] -.br -Inquire or set status of Wi\(hyFi in NetworkManager. If no arguments are supplied, -Wi\(hyFi status is printed; \fIon\fP enables Wi\(hyFi; \fIoff\fP disables Wi\(hyFi. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B wwan [on|off] -.br -Inquire or set status of WWAN in NetworkManager. If no arguments are supplied, -WWAN status is printed; \fIon\fP enables WWAN; \fIoff\fP disables WWAN. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B wimax [on|off] -.br -Inquire or set status of WiMAX in NetworkManager. If no arguments are supplied, -WiMAX status is printed; \fIon\fP enables WiMAX; \fIoff\fP disables WiMAX. -.br -Note: WiMAX support is a compile\(hytime decision, so it may be unavailable on some -installations. -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.RE - -.TP -.B con -Connections -.br -Get information about NetworkManager's connections. -.TP -.SS \fICOMMAND\fP := { list | status | up | down | delete } -.sp -.RS -.TP -.B list [id <id> | uuid <id>] -.br -List configured connections. Without a parameter, all connections -are listed. In order to get connection details, \fIid\fP with connection's -name or \fIuuid\fP with connection's UUID shall be specified. When no command -is given to the \fIcon\fP object, the default action is 'nmcli con list'. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B status -.br -Print status of active connections. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B up id <id> | uuid <id> [iface <iface>] [ap <BSSID>] [nsp <name>] [\-\-nowait] [\-\-timeout <timeout>] -.br -Activate a connection. The connection is identified by its name using \fIid\fP -or UUID using \fIuuid\fP. When requiring a particular device to activate the -connection on, the \fIiface\fP option with interface name should be given. In -case of a VPN connection, the \fIiface\fP option specify the device of the base -connection. The \fIap\fP option specify what particular AP should be used in case -of a Wi\(hyFi connection. -.RS -.PP -Available options are: -.IP \fIiface\fP 13 -\(en interface that will be used for activation -.IP \fIap\fP 13 -\(en BSSID of the AP which the command should connect to (for Wi\(hyFi connections) -.IP \fInsp\fP 13 -\(en NSP (Network Service Provider) which the command should connect to (for WiMAX connections) -.IP \fI\-\-nowait\fP 13 -\(en exit immediately without waiting for command completion -.IP \fI\-\-timeout\fP 13 -\(en how long to wait for command completion (default is 90 s) -.PP -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: ActivateConnection -arguments: according to arguments -.fi -.RE - -.TP -.B down id <id> | uuid <id> -.br -Deactivate a connection. -The connection is identified by its name using \fIid\fP -or UUID using \fIuuid\fP. -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: DeactivateConnection -arguments: according to arguments -.fi -.TP -.B delete id <id> | uuid <id> -.br -Delete a configured connection. The connection to delete is specified with -\fIid\fP (connection name) or \fIuuid\fP (connection UUID). -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager.Settings.Connection -method: Delete -arguments: none -.fi -.RE - -.TP -.B dev -Devices -.br -Get information about devices. -.TP -.SS \fICOMMAND\fP := { status | list | disconnect | wifi } -.sp -.RS -.TP -.B status -.br -Print status of devices. This is the default action, when no command -is specified to \fIdev\fP object. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B list [iface <iface>] -.br -Get detailed information about devices. Without an argument, all devices are -examined. To get information for a specific device, the \fIiface\fP argument -with the interface name should be provided. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B disconnect iface <iface> [\-\-nowait] [\-\-timeout <timeout>] -.br -Disconnect a device and prevent the device from automatically activating further -connections without user/manual intervention. -.RS -.PP -Available options are: -.IP \fI\-\-nowait\fP 13 -\(en exit immediately without waiting for command completion -.IP \fI\-\-timeout\fP 13 -\(en how long to wait for command completion (default is 10 s) -.PP -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager.Device -method: Disconnect -arguments: none -.fi -.RE -.TP -.B wifi [list [iface <iface>] [bssid <BSSID>]] -.br -List available Wi\(hyFi access points. The \fIiface\fP and \fIbssid\fP options -can be used to list APs for a particular interface or with a specific BSSID, -respectively. -.br -.nf -\fBReference to D\(hyBus:\fP -No simple reference. -.fi -.TP -.B wifi connect <(B)SSID> [password <password>] [wep\-key\-type key|phrase] [iface <iface>] [bssid <BSSID>] [name <name>] [\-\-private] [\-\-nowait] [\-\-timeout <timeout>] -.br -Connect to a Wi\(hyFi network specified by SSID or BSSID. The command creates a new -connection and then activates it on a device. This is a command\(hyline counterpart -of clicking an SSID in a GUI client. The command always creates a new connection -and thus it is mainly useful for connecting to new Wi\(hyFi networks. If a connection -for the network already exists, it's better to connect through it using -\fInmcli con up id <name>\fP. Note that only open, WEP and WPA\(hyPSK networks are -supported at the moment. It is also supposed that IP configuration is obtained via -DHCP. -.RS -.PP -Available options are: -.IP \fIpassword\fP 13 -\(en password for secured networks (WEP or WPA) -.IP \fIwep\-key\-type\fP 13 -\(en type of WEP secret, either \fIkey\fP for ASCII/HEX key or \fIphrase\fP for passphrase -.IP \fIiface\fP 13 -\(en interface that will be used for activation -.IP \fIbssid\fP 13 -\(en if specified, the created connection will be restricted just for the BSSID -.IP \fIname\fP 13 -\(en if specified, the connection will use the name (else NM creates a name itself) -.IP \fI\-\-private\fP 13 -\(en the connection will only be visible to the user who created it (else the connection is system\(hywide) -.IP \fI\-\-nowait\fP 13 -\(en exit immediately without waiting for command completion -.IP \fI\-\-timeout\fP 13 -\(en how long to wait for command completion (default is 90 s) -.PP -.br -.nf -\fBReference to D\(hyBus:\fP -interface: org.freedesktop.NetworkManager -method: AddAndActivateConnection -arguments: according to arguments -.fi -.RE - -.SH ENVIRONMENT VARIABLES -\fInmcli\fP's behavior is affected by the following environment variables. -.IP "LC_ALL" 13 -If set to a non\(hyempty string value, it overrides the values of all the other -internationalization variables. -.IP "LC_MESSAGES" 13 -Determines the locale to be used for internationalized messages. -.IP "LANG" 13 -Provides a default value for the internationalization variables that are unset -or null. - -.RE -Internationalization notes: -.br -Be aware that \fInmcli\fP is localized and that's why the output depends on -your environment. This is important to realize especially when you parse the -output. -.br -Call \fInmcli\fP as \fBLC_ALL=C nmcli\fP to be sure the locale is -set to "C" while executing in a script. - -\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP variables specify the LC_MESSAGES -locale category (in that order), which determines the language that \fInmcli\fP -uses for messages. The "C" locale is used if none of these variables are set, -and this locale uses English messages. - -.SH EXIT STATUS -\fInmcli\fP exits with status 0 if it succeeds, a value greater than 0 is -returned if an error occurs. -.IP "0" 4 -Success \(en indicates the operation succeeded -.IP "1" 4 -Unknown or unspecified error -.IP "2" 4 -Invalid user input, wrong \fInmcli\fP invocation -.IP "3" 4 -Timeout expired (see commands with \fI\-\-timeout\fP option) -.IP "4" 4 -Connection activation failed -.IP "5" 4 -Connection deactivation failed -.IP "6" 4 -Disconnecting device failed -.IP "7" 4 -Connection deletion failed -.IP "8" 4 -NetworkManager is not running -.IP "9" 4 -\fInmcli\fP and \fINetworkManager\fP versions mismatch - -.SH EXAMPLES -.IP "\fB\f(CWnmcli \-t \-f RUNNING nm\fP\fP" -.IP -tells you whether NetworkManager is running or not. - -.IP "\fB\f(CWnmcli \-t \-f STATE nm\fP\fP" -.IP -shows the overall status of NetworkManager. - -.IP "\fB\f(CWnmcli nm wifi off\fP\fP" -.IP -switches Wi\(hyFi off. - -.IP "\fB\f(CWnmcli \-p con list\fP\fP" -.IP -lists all connections NetworkManager has. - -.IP "\fB\f(CWnmcli \-f name,autoconnect con list\fP\fP" -.IP -lists all connections' names and their autoconnect settings. - -.IP "\fB\f(CWnmcli con list id \(dq\&My wired connection\(dq\&\fP\fP" -.IP -lists all details of the connection with "My wired connection" name. - -.IP "\fB\f(CWnmcli \-p con up id \(dq\&My wired connection\(dq\& iface eth0\fP\fP" -.IP -activates the connection with name "My wired connection" on interface eth0. -The \-p option makes nmcli show progress of the activation. - -.IP "\fB\f(CWnmcli con up uuid 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 ap 00:3A:98:7C:42:D3\fP\fP" -.IP -connects the Wi\(hyFi connection with UUID 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 to the AP -with BSSID 00:3A:98:7C:42:D3. - -.IP "\fB\f(CWnmcli dev status\fP\fP" -.IP -shows the status for all devices. - -.IP "\fB\f(CWnmcli dev disconnect iface em2\fP\fP" -.IP -disconnects a connection on interface em2 and marks the device as unavailable for -auto\(hyconnecting. That's why no connection will automatically be activated on the -device until the device's "autoconnect" is set to TRUE or user manually activates -a connection. - -.IP "\fB\f(CWnmcli \-f GENERAL,WIFI\-PROPERTIES dev list iface wlan0\fP\fP" -.IP -lists details for wlan0 interface; only GENERAL and WIFI\-PROPERTIES sections will be shown. - -.IP "\fB\f(CWnmcli dev wifi\fP\fP" -.IP -lists available Wi\(hyFi access points known to NetworkManager. - -.IP "\fB\f(CWnmcli dev wifi con \(dq\&Cafe Hotspot 1\(dq\& password caffeine name \(dq\&My cafe\(dq\&\fP\fP" -.IP -creates a new connection named "My cafe" and then connects it to "Cafe Hotspot 1" SSID -using "caffeine" password. This is mainly useful when connecting to "Cafe Hotspot 1" for -the first time. Next time, it is better to use 'nmcli con up id "My cafe"' so that the -existing connection profile can be used and no additional is created. - -.SH BUGS -There are probably some bugs. If you find a bug, please report it to -https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP. - -.SH SEE ALSO -.BR nm\-tool (1), -.BR nm\-online (1), -.BR NetworkManager (8), -.BR nm\-settings (5). diff --git a/man/nmcli.1.in b/man/nmcli.1.in index d1f3a0ca..d7a7a9fd 100644 --- a/man/nmcli.1.in +++ b/man/nmcli.1.in @@ -530,4 +530,6 @@ https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP. .BR nm\-tool (1), .BR nm\-online (1), .BR NetworkManager (8), -.BR nm\-settings (5). +.BR nm\-settings (5), +.BR nm\applet (1), +.BR nm\-connection\-editor (1). |