diff options
Diffstat (limited to 'docs/api/html')
| -rw-r--r-- | docs/api/html/NetworkManager.devhelp | 30 | ||||
| -rw-r--r-- | docs/api/html/NetworkManager.devhelp2 | 30 | ||||
| -rw-r--r-- | docs/api/html/home.png | bin | 0 -> 654 bytes | |||
| -rw-r--r-- | docs/api/html/index.html | 93 | ||||
| -rw-r--r-- | docs/api/html/ix01.html | 31 | ||||
| -rw-r--r-- | docs/api/html/left.png | bin | 0 -> 459 bytes | |||
| -rw-r--r-- | docs/api/html/license.html | 385 | ||||
| -rw-r--r-- | docs/api/html/ref-dbus.html | 35 | ||||
| -rw-r--r-- | docs/api/html/ref-migrating.html | 539 | ||||
| -rw-r--r-- | docs/api/html/ref-settings.html | 1337 | ||||
| -rw-r--r-- | docs/api/html/right.png | bin | 0 -> 472 bytes | |||
| -rw-r--r-- | docs/api/html/secrets-flags.html | 64 | ||||
| -rw-r--r-- | docs/api/html/spec.html | 1361 | ||||
| -rw-r--r-- | docs/api/html/style.css | 266 | ||||
| -rw-r--r-- | docs/api/html/up.png | bin | 0 -> 406 bytes |
15 files changed, 4171 insertions, 0 deletions
diff --git a/docs/api/html/NetworkManager.devhelp b/docs/api/html/NetworkManager.devhelp new file mode 100644 index 000000000..6bf8834ae --- /dev/null +++ b/docs/api/html/NetworkManager.devhelp @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="NetworkManager D-Bus Reference Manual" link="index.html" author="Dan Williams" name="NetworkManager"> + <chapters> + <sub name="D-Bus API Reference" link="ref-dbus.html"/> + <sub name="Network Configuration Setting Specification" link="ref-settings.html"> + <sub name="Configuration Settings" link="ref-settings.html#id554381"/> + <sub name="Secret flag types" link="secrets-flags.html"/> + </sub> + <sub name="Migrating from NetworkManager 0.8 to NetworkManager 0.9" link="ref-migrating.html"> + <sub name="Architecture and D-Bus API Changes in 0.9" link="ref-migrating.html#id537843"> + <sub name="Elimination of the User Settings Service" link="ref-migrating.html#id551050"/> + <sub name="User Secret Agents" link="ref-migrating.html#id532968"/> + <sub name="Settings Service Interface Changes" link="ref-migrating.html#id545506"/> + <sub name="Connection Object Interface Changes" link="ref-migrating.html#id546055"/> + <sub name="Permissions Methods Consolidation" link="ref-migrating.html#id560506"/> + <sub name="AddConnection Returns Object Path of New Connection" link="ref-migrating.html#id566633"/> + <sub name="Support for WiMAX Devices" link="ref-migrating.html#id523443"/> + <sub name="New Device States" link="ref-migrating.html#id565603"/> + <sub name="New Active Connection State" link="ref-migrating.html#id534542"/> + <sub name="Consolidated Modem Devices" link="ref-migrating.html#id533386"/> + <sub name="Secret Property Flags" link="ref-migrating.html#id514244"/> + <sub name="Deprecated Methods Removed" link="ref-migrating.html#id529216"/> + </sub> + </sub> + <sub name="Index" link="ix01.html"/> + <sub name="License" link="license.html"/> + </chapters> + <functions/> +</book> diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 new file mode 100644 index 000000000..76576f4ab --- /dev/null +++ b/docs/api/html/NetworkManager.devhelp2 @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="NetworkManager D-Bus Reference Manual" link="index.html" author="Dan Williams" name="NetworkManager" version="2" language="c"> + <chapters> + <sub name="D-Bus API Reference" link="ref-dbus.html"/> + <sub name="Network Configuration Setting Specification" link="ref-settings.html"> + <sub name="Configuration Settings" link="ref-settings.html#id554381"/> + <sub name="Secret flag types" link="secrets-flags.html"/> + </sub> + <sub name="Migrating from NetworkManager 0.8 to NetworkManager 0.9" link="ref-migrating.html"> + <sub name="Architecture and D-Bus API Changes in 0.9" link="ref-migrating.html#id537843"> + <sub name="Elimination of the User Settings Service" link="ref-migrating.html#id551050"/> + <sub name="User Secret Agents" link="ref-migrating.html#id532968"/> + <sub name="Settings Service Interface Changes" link="ref-migrating.html#id545506"/> + <sub name="Connection Object Interface Changes" link="ref-migrating.html#id546055"/> + <sub name="Permissions Methods Consolidation" link="ref-migrating.html#id560506"/> + <sub name="AddConnection Returns Object Path of New Connection" link="ref-migrating.html#id566633"/> + <sub name="Support for WiMAX Devices" link="ref-migrating.html#id523443"/> + <sub name="New Device States" link="ref-migrating.html#id565603"/> + <sub name="New Active Connection State" link="ref-migrating.html#id534542"/> + <sub name="Consolidated Modem Devices" link="ref-migrating.html#id533386"/> + <sub name="Secret Property Flags" link="ref-migrating.html#id514244"/> + <sub name="Deprecated Methods Removed" link="ref-migrating.html#id529216"/> + </sub> + </sub> + <sub name="Index" link="ix01.html"/> + <sub name="License" link="license.html"/> + </chapters> + <functions/> +</book> diff --git a/docs/api/html/home.png b/docs/api/html/home.png Binary files differnew file mode 100644 index 000000000..17003611d --- /dev/null +++ b/docs/api/html/home.png diff --git a/docs/api/html/index.html b/docs/api/html/index.html new file mode 100644 index 000000000..e418ad07d --- /dev/null +++ b/docs/api/html/index.html @@ -0,0 +1,93 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NetworkManager D-Bus Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="next" href="ref-dbus.html" title="D-Bus API Reference"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager D-Bus Reference Manual</p></th></tr></table></div> +<div><div class="authorgroup"><div class="author"> +<h3 class="author"> +<span class="firstname">Dan</span> <span class="surname">Williams</span> +</h3> +<div class="affiliation"><div class="address"><p><br> + <code class="email"><<a class="email" href="mailto:dcbw@redhat.com">dcbw@redhat.com</a>></code><br> + </p></div></div> +</div></div></div> +<div><p class="releaseinfo">Version 0.8.998 +</p></div> +<div><p class="copyright">Copyright © 2011 The NetworkManager Authors</p></div> +<div><div class="legalnotice"> +<a name="id484261"></a><p> + Permission is granted to copy, distribute and/or modify this + document under the terms of the <em class="citetitle">GNU Free + Documentation License</em>, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the <em class="citetitle">GNU Free + Documentation License</em> from the Free Software + Foundation by visiting <a class="ulink" href="http://www.fsf.org" target="_top">their Web site</a> or by writing + to: + + </p> +<div class="address"><p><br> + The Free Software Foundation, Inc.,<br> + <span class="street">59 Temple Place</span> - Suite 330,<br> + <span class="city">Boston</span>, <span class="state">MA</span> <span class="postcode">02111-1307</span>,<br> + <span class="country">USA</span><br> + </p></div> +<p> + </p> +<p> + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and those trademarks + are made aware to the members of the GNOME Documentation + Project, the names have been printed in caps or initial caps. + </p> +</div></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="ref-dbus.html">D-Bus API Reference</a></span></dt> +<dt><span class="chapter"><a href="ref-settings.html">Network Configuration Setting Specification</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ref-settings.html#id554381">Configuration Settings</a></span></dt> +<dt><span class="section"><a href="secrets-flags.html">Secret flag types</a></span></dt> +</dl></dd> +<dt><span class="chapter"><a href="ref-migrating.html">Migrating from NetworkManager 0.8 to NetworkManager 0.9</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ref-migrating.html#id537843">Architecture and D-Bus API Changes in 0.9</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ref-migrating.html#id551050">Elimination of the User Settings Service</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id532968">User Secret Agents</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id545506">Settings Service Interface Changes</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id546055">Connection Object Interface Changes</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id560506">Permissions Methods Consolidation</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id566633">AddConnection Returns Object Path of New Connection</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id523443">Support for WiMAX Devices</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id565603">New Device States</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id534542">New Active Connection State</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id533386">Consolidated Modem Devices</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id514244">Secret Property Flags</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id529216">Deprecated Methods Removed</a></span></dt> +</dl></dd> +</dl></dd> +<dt><span class="index"><a href="ix01.html">Index</a></span></dt> +<dt><span class="appendix"><a href="license.html">A. License</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html new file mode 100644 index 000000000..fe82a551d --- /dev/null +++ b/docs/api/html/ix01.html @@ -0,0 +1,31 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="ref-migrating.html" title="Migrating from NetworkManager 0.8 to NetworkManager 0.9"> +<link rel="next" href="license.html" title="Appendix A. License"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-migrating.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="license.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id514153"></a>Index</h2></div></div></div> +<div class="index"></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/left.png b/docs/api/html/left.png Binary files differnew file mode 100644 index 000000000..2d05b3d5b --- /dev/null +++ b/docs/api/html/left.png diff --git a/docs/api/html/license.html b/docs/api/html/license.html new file mode 100644 index 000000000..fc0b0a38b --- /dev/null +++ b/docs/api/html/license.html @@ -0,0 +1,385 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Appendix A. License</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="ix01.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ix01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td> </td> +</tr></table> +<div class="appendix"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="license"></a>Appendix A. License</h2></div></div></div> +<p> +</p> +<pre class="programlisting">Unless a COPYING file in a subdirectory or file-specific license headers +specify a different license, the following applies to all files in this +directory and all subdirectories. + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. + +</pre> +<p> + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/ref-dbus.html b/docs/api/html/ref-dbus.html new file mode 100644 index 000000000..29392bed4 --- /dev/null +++ b/docs/api/html/ref-dbus.html @@ -0,0 +1,35 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>D-Bus API Reference</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="next" href="ref-settings.html" title="Network Configuration Setting Specification"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ref-settings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="ref-dbus"></a>D-Bus API Reference</h2></div></div></div> +<p> + This part documents the D-Bus interface used to access the + NetworkManager daemon. + </p> +<a class="ulink" href="spec.html" target="_top">spec.html</a> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html new file mode 100644 index 000000000..a08e8f081 --- /dev/null +++ b/docs/api/html/ref-migrating.html @@ -0,0 +1,539 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Migrating from NetworkManager 0.8 to NetworkManager 0.9</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="secrets-flags.html" title="Secret flag types"> +<link rel="next" href="ix01.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="secrets-flags.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="ref-migrating"></a>Migrating from NetworkManager 0.8 to NetworkManager 0.9</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="ref-migrating.html#id537843">Architecture and D-Bus API Changes in 0.9</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ref-migrating.html#id551050">Elimination of the User Settings Service</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id532968">User Secret Agents</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id545506">Settings Service Interface Changes</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id546055">Connection Object Interface Changes</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id560506">Permissions Methods Consolidation</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id566633">AddConnection Returns Object Path of New Connection</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id523443">Support for WiMAX Devices</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id565603">New Device States</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id534542">New Active Connection State</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id533386">Consolidated Modem Devices</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id514244">Secret Property Flags</a></span></dt> +<dt><span class="section"><a href="ref-migrating.html#id529216">Deprecated Methods Removed</a></span></dt> +</dl></dd> +</dl></div> +<p> + NetworkManager 0.9 is a new major version of NetworkManager that breaks + both API and ABI compared to previous versions. These changes are + intended to make communication with NetworkManager much simpler, especially + for network control and configuration programs. Thankfully, most changes + are not difficult to implement, and the advantages of the simpler + architecture of NetworkManager 0.9 greatly outweight the effort of + updating client programs. + </p> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="id537843"></a>Architecture and D-Bus API Changes in 0.9</h2></div></div></div> +<p> + This section details the architectural and D-Bus API changes in + NetworkManager 0.9. + </p> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id551050"></a>Elimination of the User Settings Service</h3></div></div></div> +<p> + Previously there were two "settings services", or D-Bus services that + provided and saved network configuration information. NetworkManager + owned the "system" settings service, and one user-level applet owned the + "user" settings service. Now, the "user" settings service has been + eliminated, so clients only have to track one D-Bus service to read and + update network configuration. The functionality of the old user settings + service has been replaced with a "permissions" key on each connection + object to preserve the ability to restrict which users can use the + connection, and with a "secret agent" D-Bus API for user-session-level + secure storage of network secrets and passwords. + </p> +<p> + Elimination of the user settings service provides the following advantages + for clients of NetworkManager: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem">Simpler discovery of network configuration and change tracking</li> +<li class="listitem">Simpler storage of user-level network secrets by control applets</li> +<li class="listitem">Correct operation of fast-user switching and multi-seat configurations</li> +<li class="listitem">More granular network connection permissions for system administrators</li> +<li class="listitem">Connections are now system-wide by default (unless restricted by the user or system administrator)</li> +<li class="listitem">Easier deployment of user-specific connections (ie, VPNs)</li> +</ul></div> +<p> + </p> +<p> + With this change, D-Bus methods that previously took a "service name" + argument (like + <code class="literal">org.freedesktop.NetworkManager.ActivateConnection</code>) and + objects with service name properties (like ActiveConnection objects) no + longer have those arguments or properties. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> if you develop a network control + applet that talks to NetworkManager and used to provide a user settings + service, you can eliminate that code and rely on NetworkManager for all + storage of network configuration. Your applet should now implement the + Secret Agent D-Bus API (see below) to store user-specific secrets, and + add legacy user-specific configuration to NetworkManager when run. More + information about both these changes follows. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id532968"></a>User Secret Agents</h3></div></div></div> +<p> + Even with the elimination of the user settings service, in some cases it + is still desirable to store secrets in the user's session and not in + system-wide storage (and thus available to all users). To allow this + functionality the concept of agents has been introduced. Using the new + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.AgentManager" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.AgentManager</code></a> + D-Bus interface provided by NetworkManager, user applications can register + themselves as "secret agents", ie programs capable of saving and providing + secrets to NetworkManager. The agent should export the + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.SecretAgent" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.SecretAgent</code></a> + D-Bus interface, but should NOT claim a bus name on the system or session + bus. Instead, NetworkManager talks to the agent directly over the D-Bus + connection which the agent used to register itself. + </p> +<p> + Each agent must send a unique identifier to NetworkManager when it + registers. This identifier must follow certain rules (see the NM D-Bus + API documentation for more details) but looks essentially the same as + a D-Bus service name. Only one agent using a given identifier may be + registered at the same time. The agent is automatically unregistered + if it disconnects from D-Bus or exits. + </p> +<p> + When NetworkManager requires secrets during the attempt to connect to a + network, and no secrets are available from the internal settings service, + NetworkManager queries each registered agent for secrets. Agents that + are in "active" user sessions (as determined by ConsoleKit) are preferred + over inactive ones. Only agents belonging to users who have permission + to view and modify the connection are queried. For more information on + connection permissions, see below. + </p> + When secrets are requested, the agent is also sent a set of flags that + modify the behavior of the request. By default, the agent should never + attempt to query the user for secrets, but should simply return any + available saved secrets. Other flags allow the agent to explicitly + request new secrets from the user. + <p> + <span class="strong"><strong>Action:</strong></span> the parts of a previous user + settings service that handled secrets may be easily repurposed as the bulk + of the implementation of a secret agent. The agent is sent all available + connection settings, and from those should be able to retrieve or save + any saved user secrets, or to request new secrets from the user. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id545506"></a>Settings Service Interface Changes</h3></div></div></div> +<p> + With the elimination of the user settings service, the old + <code class="literal">org.freedesktop.NetworkManagerUserSettings</code> and + <code class="literal">org.freedesktop.NetworkManagerSystemSettings</code> D-Bus + service names are no longer used. Instead NetworkManager provides the + settings service using its own D-Bus service name, + <code class="literal">org.freedesktop.NetworkManager</code>. The object path of + the settings service remains unchanged. + </p> +<p> + Additionally, the D-Bus interface of the settings service has changed + to <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Settings" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Settings</code></a> from + the old interface name of + <code class="literal">org.freedesktop.NetworkManagerSettings</code>, and the old + <code class="literal">org.freedesktop.NetworkManagerSettings.System</code> + interface has been merged into the new + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Settings" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Settings</code></a> interface + as the split no longer made sense. This includes the + <code class="literal">SaveHostname</code> method and the <code class="literal">Hostname</code> + and <code class="literal">CanModify</code> properties. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> change the service name that + your application uses to request system network settings to + <code class="literal">org.freedesktop.NetworkManager</code>, and update the D-Bus + interface that codes uses to talk to the settings service to + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Settings" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Settings</code></a>. + Listen for hostname changes using the new interface name as well. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id546055"></a>Connection Object Interface Changes</h3></div></div></div> +<p> + Consistent with the interface changes to the Settings object, the + Connection object's D-Bus interface has changed to + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Settings.Connection" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection</code></a> + from the previous + <code class="literal">org.freedesktop.NetworkManagerSettings.Connection</code>. + </p> +<p> + Additionally, the + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection.Updated</code> + signal of the Connection object no longer includes the updated settings + data argument, as that might allow users who are not authorized to + view the connection details to do so. Instead, when a client receives the + Updated signal, it should requery the Connection's settings with the + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection.GetSettings</code> + method. If the client receives an error as a result of this method call, + it should assume the connection has been deleted. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> where code manipulates + Connection objects, update the D-Bus interface that code uses to be + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection</code>. + Additionally, code that listens for the + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection.Updated</code> + signal should no longer expect the new settings data as an argument, but + instead should request the new settings data using the + <code class="literal">org.freedesktop.NetworkManager.Settings.Connection.GetSettings</code> + method. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id560506"></a>Permissions Methods Consolidation</h3></div></div></div> +<p> + Previously there were two D-Bus method calls to retrieve the list of + operations that a user client could perform, and two signals notifying + callers that they should recheck permissions. Those two calls were: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<code class="literal">org.freedesktop.NetworkManagerSettings.System.GetPermissions</code> + which returned a bitfield of operations the caller was allowed to + perform related to modify system network settings and the machine + hostname + </li> +<li class="listitem"> +<code class="literal">org.freedesktop.NetworkManager.GetPermissions</code> which + returned a dictionary mapping permission names to result strings like + "yes", "auth", or "no", relating to network control permissions like + the ability to enable or disable WiFi. + </li> +</ul></div> +<p> + These two calls have been consolidated into an enhanced + <code class="literal">org.freedesktop.NetworkManager.GetPermissions</code> call that + uses the same arguments, but includes all permissions, including those which + the settings service used to handle. + </p> +<p> + With this change, the bitfield items from + <code class="literal">org.freedesktop.NetworkManagerSettings.System.GetPermissions</code> + are now string-based permissions. The mapping is as follows: + </p> +<div class="table"> +<a name="id555187"></a><p class="title"><b>Table 17. </b></p> +<div class="table-contents"><table border="1"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th>Old bitfield value</th> +<th>New permission name</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">0x1 (connection-modify)</pre></td> +<td> + <code class="literal">org.freedesktop.NetworkManager.settings.modify.system</code> + or <code class="literal">org.freedesktop.NetworkManager.settings.modify.system</code> + depending on the permissions of the connection. + </td> +</tr> +<tr> +<td><pre class="screen">0x2 (wifi-share-protected)</pre></td> +<td> + <code class="literal">org.freedesktop.NetworkManager.wifi.share.protected</code> + </td> +</tr> +<tr> +<td><pre class="screen">0x4 (wifi-share-open)</pre></td> +<td> + <code class="literal">org.freedesktop.NetworkManager.wifi.share.open</code> + </td> +</tr> +<tr> +<td><pre class="screen">0x8 (hostname-modify)</pre></td> +<td> + <code class="literal">org.freedesktop.NetworkManager.settings.modify.hostname</code> + </td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> + </p> +<p> + <span class="strong"><strong>Action:</strong></span> modify handling of existing + code that checks permissions to recognize the new permissions names for + old system settings permissions, and remove code that used to call + <code class="literal">org.freedesktop.NetworkManagerSettings.System.GetPermissions</code>. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id566633"></a>AddConnection Returns Object Path of New Connection</h3></div></div></div> +<p> + The <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Settings" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Settings.AddConnection</code> + </a> method call now returns the object path of the newly added + connection. Previously, if code wanted to manipulate a connection + post-addition, it had to wait for the new connection to be announced via + the NewConnection signal by matching connection UUIDs. Now the object + path is returned and this workaround is no longer required. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> update code that adds new + connections to handle the object path returned from AddConnection, and + remove workarounds for finding the new connection via signals. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id523443"></a>Support for WiMAX Devices</h3></div></div></div> +<p> + NetworkManager now supports Intel WiMAX mobile broadband devices. A + corresponding device type (<code class="literal">NM_DEVICE_TYPE_WIMAX</code>) and + a new <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Device.WiMax" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Device.WiMax</code></a> + D-Bus interface have been added. Furthermore, to support connection to + different WiMAX Network Service Providers (NSPs) the + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Device.WiMax.Nsp" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Device.WiMax.Nsp</code></a> + interface has been added to access information about each available + WiMAX network. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> update code that handles + devices and/or displays status to users to recognize the new device type, + and to display available WiMAX NSPs similar to how WiFi Access Points + are displayed. Also update code that creates new connections to allow + creation of new WiMAX connections. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id565603"></a>New Device States</h3></div></div></div> +<p> + A few <a class="ulink" href="spec.html#type-NM_DEVICE_STATE" target="_top">new device states</a> + have been added, and all device states have been renumbered for flexibility. + The new devices states IP_CHECK, SECONDARIES, and DEACTIVATING. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> where code checks device state + or shows UI indication of the device's state, make sure the new device + states are processed correctly, and that code in switch()-type statements + is updated to handle the new states. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id534542"></a>New Active Connection State</h3></div></div></div> +<p> + Along with the new device states, an + <a class="ulink" href="spec.html#type-NM_ACTIVE_CONNECTION_STATE" target="_top">additional + ActiveConnection state</a> has been added: DEACTIVATING. This state + is entered when the connection is being torn down and deactivated. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> where code checks active + connection states or shows UI indication of active connection states, make + sure the DEACTIVATING state is processed correctly, and that code in + switch()-type statements is updated to handle it. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id533386"></a>Consolidated Modem Devices</h3></div></div></div> +<p> + Many new mobile broadband devices support multiple access families, like + Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE + or UMTS/LTE modems like the Pantech UML290. The previous hard split + between CDMA/EVDO and GSM/UMTS device classes was not flexible enough to + deal with these new multi-mode devices. Thus the previously separate + CDMA and GSM device classes have been combined into a single Modem + device class, which exposes both hardware "ModemCapabilities" and + runtime "CurrentCapabilities" which represent generic access technology + families like CDMA/EVDO, GSM/UMTS, and LTE which the device supports. + ModemCapabilities indicate all the access technology families which the + modem is capable of supporting, while CurrentCapabilities indicate the + immediate access technology families the device supports without reloading + the firmware and thus restarting the device. + </p> +<p> + Along with this change, the + <code class="literal">org.freedesktop.NetworkManager.Device.Serial</code> + interface has been removed as it's functionality will be incorporated + into the + <a class="ulink" href="spec.html#org.freedesktop.NetworkManager.Device.Modem" target="_top"> + <code class="literal">org.freedesktop.NetworkManager.Device.Modem</code></a> + interface in the future. + </p> +<p> + <span class="strong"><strong>Action:</strong></span> combine code that checks for + the old CDMA and GSM device types, and instead handle the new Modem device + type. Where behavior must change based on the capabilities of the device, + check the CurrentCapabilities device property to determine whether to + treat the device as CDMA, GSM, or LTE for purposes of configuration and + status. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id514244"></a>Secret Property Flags</h3></div></div></div> +<p> + In the Connection object's configuration properties, each setting's secret + properties (like WiFi passphrases, or public key passwords, etc) now has + an associated "flags" property that changes how NetworkManager treats the + secret. The "flags" property is a bitfield of one or more of the + following values: + </p> +<div class="table"> +<a name="id514253"></a><p class="title"><b>Table 18. </b></p> +<div class="table-contents"><table border="1"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th>Flag Value</th> +<th>Meaning</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">0x00 (none)</pre></td> +<td> + NetworkManager is responsible for providing and storing this + secret (default) + </td> +</tr> +<tr> +<td><pre class="screen">0x01 (agent-owned)</pre></td> +<td> + A user secret agent is responsible for providing and storing + this secret; when it is required agents will be asked to + retrieve it + </td> +</tr> +<tr> +<td><pre class="screen">0x02 (not saved)</pre></td> +<td> + The secret is not saved, and should be requested each time it + is required. Used for OTP/token configurations where the + secret changes periodically, or if the user simply wants to + manually enter the secret each time. + </td> +</tr> +<tr> +<td><pre class="screen">0x04 (not required)</pre></td> +<td> + In situations where it cannot be automatically determined that + the secret is required (some VPNs and PPP providers dont require + all possible secrets) this flag indicates that the specific + secret is not required. + </td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> + </p> +<p> + <span class="strong"><strong>Action:</strong></span> user interface code which + handles entry of connection secrets should be updated to read and set + secret flags. For example, code that creates new VPN connections may want + to set the "agent-owned" flag to ensure that the user's VPN password is + not available to all users. EAP-TLS and VPN interface code might add a + checkbox that toggles the "not saved" bit to indicate that the + password/PIN code should be requested from a hardware token each time it + is required. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id529216"></a>Deprecated Methods Removed</h3></div></div></div> +<p> + A few methods and signals of the <code class="literal">org.freedesktop.NetworkManager</code> + interface deprecated in version 0.7 have been removed. All the + replacement methods and signals have existed since version 0.7 and so are + not new to this version of NetworkManager, but some older programs may + be using removed items. The following table lists the removed items and + their replacements: + </p> +<div class="table"> +<a name="id529230"></a><p class="title"><b>Table 19. </b></p> +<div class="table-contents"><table border="1"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th>Removed Item</th> +<th>Replacement</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">StateChange signal</pre></td> +<td> + Use the <code class="literal">StateChanged</code> signal, which has the + same arguments. + </td> +</tr> +<tr> +<td><pre class="screen">sleep() and wake() methods</pre></td> +<td> + Use the <code class="literal">Sleep()</code> method instead, which takes + a boolean argument indicating whether NetworkManager should + go to sleep or wake up. + </td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> + </p> +<p> + <span class="strong"><strong>Action:</strong></span> update code to use these + replacement methods and properties where it used old deprecated ones + </p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html new file mode 100644 index 000000000..aaa4bbd3a --- /dev/null +++ b/docs/api/html/ref-settings.html @@ -0,0 +1,1337 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Network Configuration Setting Specification</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="ref-dbus.html" title="D-Bus API Reference"> +<link rel="next" href="secrets-flags.html" title="Secret flag types"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="secrets-flags.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="ref-settings"></a>Network Configuration Setting Specification</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="ref-settings.html#id554381">Configuration Settings</a></span></dt> +<dt><span class="section"><a href="secrets-flags.html">Secret flag types</a></span></dt> +</dl></div> +<p> + This part documents the properties and value types of each "Setting" + object that composes the basic unit of NetworkManager configuration, + the "Connection". Each Connection object is simply a dictionary mapping + setting names (like "wimax" or "bluetooth") to a dictionary of + key/value pairs that represents each itself. + </p> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="id554381"></a>Configuration Settings</h2></div></div></div> +<p> +</p> +<div class="table"> +<a name="id554388"></a><p class="title"><b>Table 1. 802-1x setting</b></p> +<div class="table-contents"><table summary="802-1x setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-1x</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">eap</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</td> +</tr> +<tr> +<td><pre class="screen">identity</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Identity string for EAP authentication methods. Often the user's user or login name.</td> +</tr> +<tr> +<td><pre class="screen">anonymous-identity</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td> +</tr> +<tr> +<td><pre class="screen">ca-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the CA certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</td> +</tr> +<tr> +<td><pre class="screen">ca-path</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'ca-cert' property.</td> +</tr> +<tr> +<td><pre class="screen">client-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the client certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</td> +</tr> +<tr> +<td><pre class="screen">phase1-peapver</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Forces which PEAP version is used when PEAP is set as the EAP method in 'eap' property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to '0' or '1' to force that specific PEAP version.</td> +</tr> +<tr> +<td><pre class="screen">phase1-peaplabel</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to '1' to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</td> +</tr> +<tr> +<td><pre class="screen">phase1-fast-provisioning</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed values are '0' (disabled), '1' (allow unauthenticated provisioning), '2' (allow authenticated provisioning), and '3' (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</td> +</tr> +<tr> +<td><pre class="screen">phase2-auth</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td> +</tr> +<tr> +<td><pre class="screen">phase2-autheap</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized EAP-based 'phase 2' methods are 'md5', 'mschapv2', 'otp', 'gtc', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td> +</tr> +<tr> +<td><pre class="screen">phase2-ca-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the 'phase 2' CA certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currentlysupported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</td> +</tr> +<tr> +<td><pre class="screen">phase2-ca-path</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'phase2-ca-cert' property.</td> +</tr> +<tr> +<td><pre class="screen">phase2-client-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the 'phase 2' client certificate if used by the EAP method specified in the 'phase2-eap' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</td> +</tr> +<tr> +<td><pre class="screen">password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Password used for EAP authentication methods.</td> +</tr> +<tr> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the 802.1x password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">private-key</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the private key when the 'eap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</td> +</tr> +<tr> +<td><pre class="screen">private-key-password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The password used to decrypt the private key specified in the 'private-key' property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</td> +</tr> +<tr> +<td><pre class="screen">private-key-password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the 802.1x private key password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">phase2-private-key</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Contains the 'phase 2' inner private key when the 'phase2-eap' or 'phase2-autheap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the 'phase2-private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'phase2-private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</td> +</tr> +<tr> +<td><pre class="screen">phase2-private-key-password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.</td> +</tr> +<tr> +<td><pre class="screen">phase2-private-key-password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the 802.1x phase2 private key password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">system-ca-certs</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When TRUE, overrides 'ca-path' and 'phase2-ca-path' properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the 'ca-cert' and 'phase2-ca-cert' properties.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id541403"></a><p class="title"><b>Table 2. bluetooth setting</b></p> +<div class="table-contents"><table summary="bluetooth setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">bluetooth</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">bdaddr</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>The Bluetooth address of the device</td> +</tr> +<tr> +<td><pre class="screen">type</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id541536"></a><p class="title"><b>Table 3. cdma setting</b></p> +<div class="table-contents"><table summary="cdma setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">cdma</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">number</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</td> +</tr> +<tr> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td> +</tr> +<tr> +<td><pre class="screen">password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td> +</tr> +<tr> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the CDMA password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id541734"></a><p class="title"><b>Table 4. connection setting</b></p> +<div class="table-contents"><table summary="connection setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">connection</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">id</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>User-readable connection identifier/name. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it.</td> +</tr> +<tr> +<td><pre class="screen">uuid</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes.</td> +</tr> +<tr> +<td><pre class="screen">type</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, '802-3-ethernet' or '802-11-wireless' or 'bluetooth', etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, 'vpn' or 'bridge', etc).</td> +</tr> +<tr> +<td><pre class="screen">permissions</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this array. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the 'user' [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ':' character. Any [reserved] information (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</td> +</tr> +<tr> +<td><pre class="screen">autoconnect</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>If TRUE, NetworkManager will activate this connection when its network resources are available. If FALSE, the connection must be manually activated by the user or some other mechanism.</td> +</tr> +<tr> +<td><pre class="screen">timestamp</pre></td> +<td><pre class="screen">uint64</pre></td> +<td><pre class="screen">0</pre></td> +<td>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</td> +</tr> +<tr> +<td><pre class="screen">read-only</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id542035"></a><p class="title"><b>Table 5. gsm setting</b></p> +<div class="table-contents"><table summary="gsm setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">gsm</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">number</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. In most cases, leave the number blank and a number selecting the APN specified in the 'apn' property will be used automatically when required.</td> +</tr> +<tr> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td> +</tr> +<tr> +<td><pre class="screen">password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td> +</tr> +<tr> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the GSM password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">apn</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</td> +</tr> +<tr> +<td><pre class="screen">network-id</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</td> +</tr> +<tr> +<td><pre class="screen">network-type</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all devices allow network preference control.</td> +</tr> +<tr> +<td><pre class="screen">pin</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</td> +</tr> +<tr> +<td><pre class="screen">pin-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the GSM SIM PIN. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">allowed-bands</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">1</pre></td> +<td>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</td> +</tr> +<tr> +<td><pre class="screen">home-only</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id542460"></a><p class="title"><b>Table 6. ipv4 setting</b></p> +<div class="table-contents"><table summary="ipv4 setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ipv4</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">method</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.</td> +</tr> +<tr> +<td><pre class="screen">dns</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen">[]</pre></td> +<td>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> +</tr> +<tr> +<td><pre class="screen">dns-search</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> +</tr> +<tr> +<td><pre class="screen">addresses</pre></td> +<td><pre class="screen">array of array of uint32</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</td> +</tr> +<tr> +<td><pre class="screen">routes</pre></td> +<td><pre class="screen">array of array of uint32</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</td> +</tr> +<tr> +<td><pre class="screen">ignore-auto-routes</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When the method is set to 'auto' and this property to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</td> +</tr> +<tr> +<td><pre class="screen">ignore-auto-dns</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-client-id</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>A string sent to the DHCP server to identify the local machine which the DHCP server may use to cusomize the DHCP lease and options.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-send-hostname</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the 'dhcp-hostname' property is empty and this property is TRUE, the current persistent hostname of the computer is sent.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-hostname</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</td> +</tr> +<tr> +<td><pre class="screen">never-default</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</td> +</tr> +<tr> +<td><pre class="screen">may-fail</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id571362"></a><p class="title"><b>Table 7. ipv6 setting</b></p> +<div class="table-contents"><table summary="ipv6 setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ipv6</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">method</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignored' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</td> +</tr> +<tr> +<td><pre class="screen">dns</pre></td> +<td><pre class="screen">array of byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> +</tr> +<tr> +<td><pre class="screen">dns-search</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> +</tr> +<tr> +<td><pre class="screen">addresses</pre></td> +<td><pre class="screen">array of (byte array, uint32, byte array)</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</td> +</tr> +<tr> +<td><pre class="screen">routes</pre></td> +<td><pre class="screen">array of (byte array, uint32, byte array, uint32)</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</td> +</tr> +<tr> +<td><pre class="screen">ignore-auto-routes</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</td> +</tr> +<tr> +<td><pre class="screen">ignore-auto-dns</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</td> +</tr> +<tr> +<td><pre class="screen">never-default</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</td> +</tr> +<tr> +<td><pre class="screen">may-fail</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id571680"></a><p class="title"><b>Table 8. 802-11-olpc-mesh setting</b></p> +<div class="table-contents"><table summary="802-11-olpc-mesh setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-olpc-mesh</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">ssid</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>SSID of the mesh network to join.</td> +</tr> +<tr> +<td><pre class="screen">channel</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Channel on which the mesh network to join is located.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-anycast-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the the request.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id571818"></a><p class="title"><b>Table 9. ppp setting</b></p> +<div class="table-contents"><table summary="ppp setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ppp</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">noauth</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</td> +</tr> +<tr> +<td><pre class="screen">refuse-eap</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the EAP authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">refuse-pap</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the PAP authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">refuse-chap</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the CHAP authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">refuse-mschap</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the MSCHAP authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">refuse-mschapv2</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">nobsdcomp</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, BSD compression will not be requested.</td> +</tr> +<tr> +<td><pre class="screen">nodeflate</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, 'deflate' compression will not be requested.</td> +</tr> +<tr> +<td><pre class="screen">no-vj-comp</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td> +</tr> +<tr> +<td><pre class="screen">require-mppe</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</td> +</tr> +<tr> +<td><pre class="screen">require-mppe-128</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the 'require-mppe' property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</td> +</tr> +<tr> +<td><pre class="screen">mppe-stateful</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td> +</tr> +<tr> +<td><pre class="screen">crtscts</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</td> +</tr> +<tr> +<td><pre class="screen">baud</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</td> +</tr> +<tr> +<td><pre class="screen">mru</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</td> +</tr> +<tr> +<td><pre class="screen">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td> +</tr> +<tr> +<td><pre class="screen">lcp-echo-failure</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The 'lcp-echo-interval' property must also be set to a non-zero value if this property is used.</td> +</tr> +<tr> +<td><pre class="screen">lcp-echo-interval</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id572348"></a><p class="title"><b>Table 10. pppoe setting</b></p> +<div class="table-contents"><table summary="pppoe setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">pppoe</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">service</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</td> +</tr> +<tr> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Username used to authenticate with the PPPoE service.</td> +</tr> +<tr> +<td><pre class="screen">password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Password used to authenticate with the PPPoE service.</td> +</tr> +<tr> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the PPPoE password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id572513"></a><p class="title"><b>Table 11. serial setting</b></p> +<div class="table-contents"><table summary="serial setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">serial</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">baud</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">57600</pre></td> +<td>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</td> +</tr> +<tr> +<td><pre class="screen">bits</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">8</pre></td> +<td>Byte-width of the serial communication. The 8 in '8n1' for example.</td> +</tr> +<tr> +<td><pre class="screen">parity</pre></td> +<td><pre class="screen">gchar</pre></td> +<td><pre class="screen">110</pre></td> +<td>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</td> +</tr> +<tr> +<td><pre class="screen">stopbits</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">1</pre></td> +<td>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</td> +</tr> +<tr> +<td><pre class="screen">send-delay</pre></td> +<td><pre class="screen">uint64</pre></td> +<td><pre class="screen">0</pre></td> +<td>Time to delay between each byte sent to the modem, in microseconds.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id572704"></a><p class="title"><b>Table 12. vpn setting</b></p> +<div class="table-contents"><table summary="vpn setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">vpn</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">service-type</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</td> +</tr> +<tr> +<td><pre class="screen">user-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>User name of the currently logged in user for connections provided by the user settings service. This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration. The VPN plugin itself decides which user name to use.</td> +</tr> +<tr> +<td><pre class="screen">data</pre></td> +<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">[ ]</pre></td> +<td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td> +</tr> +<tr> +<td><pre class="screen">secrets</pre></td> +<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">[ ]</pre></td> +<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id572870"></a><p class="title"><b>Table 13. wimax setting</b></p> +<div class="table-contents"><table summary="wimax setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">wimax</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">network-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Network Service Provider (NSP) name of the WiMAX network this connection should use.</td> +</tr> +<tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id572994"></a><p class="title"><b>Table 14. 802-3-ethernet setting</b></p> +<div class="table-contents"><table summary="802-3-ethernet setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-3-ethernet</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">port</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Specific port type to use if multiple the device supports multiple attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. If the device supports only one port type, this setting is ignored.</td> +</tr> +<tr> +<td><pre class="screen">speed</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</td> +</tr> +<tr> +<td><pre class="screen">duplex</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</td> +</tr> +<tr> +<td><pre class="screen">auto-negotiate</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</td> +</tr> +<tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> +</tr> +<tr> +<td><pre class="screen">cloned-mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> +</tr> +<tr> +<td><pre class="screen">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> +</tr> +<tr> +<td><pre class="screen">s390-subchannels</pre></td> +<td><pre class="screen">GPtrArray_gchararray_</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</td> +</tr> +<tr> +<td><pre class="screen">s390-nettype</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</td> +</tr> +<tr> +<td><pre class="screen">s390-options</pre></td> +<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">[ ]</pre></td> +<td>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id573400"></a><p class="title"><b>Table 15. 802-11-wireless setting</b></p> +<div class="table-contents"><table summary="802-11-wireless setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-wireless</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">ssid</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>SSID of the WiFi network. Must be specified.</td> +</tr> +<tr> +<td><pre class="screen">mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>WiFi network mode; one of 'infrastructure' or 'adhoc'. If blank, infrastructure is assumed.</td> +</tr> +<tr> +<td><pre class="screen">band</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</td> +</tr> +<tr> +<td><pre class="screen">channel</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</td> +</tr> +<tr> +<td><pre class="screen">bssid</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</td> +</tr> +<tr> +<td><pre class="screen">rate</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</td> +</tr> +<tr> +<td><pre class="screen">tx-power</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</td> +</tr> +<tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> +</tr> +<tr> +<td><pre class="screen">cloned-mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> +</tr> +<tr> +<td><pre class="screen">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> +</tr> +<tr> +<td><pre class="screen">seen-bssids</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>A list of BSSIDs (each BSSID formatted as a MAC address like '00:11:22:33:44:55') that have been detected as part of the WiFI network. The settings service will usually populate this property by periodically asking NetworkManager what the device's current AP is while connected to the network (or monitoring the device's 'active-ap' property) and adding the current AP's BSSID to this list. This list helps NetworkManager find hidden APs by matching up scan results with the BSSIDs in this list.</td> +</tr> +<tr> +<td><pre class="screen">security</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id573878"></a><p class="title"><b>Table 16. 802-11-wireless-security setting</b></p> +<div class="table-contents"><table summary="802-11-wireless-security setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-wireless-security</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">key-mgmt</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.</td> +</tr> +<tr> +<td><pre class="screen">wep-tx-keyidx</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</td> +</tr> +<tr> +<td><pre class="screen">auth-alg</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the 802.11 authentication algorithm required by the AP here. One of 'open' for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') the 'leap-username' and 'leap-password' properties must be specified.</td> +</tr> +<tr> +<td><pre class="screen">proto</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</td> +</tr> +<tr> +<td><pre class="screen">pairwise</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td> +</tr> +<tr> +<td><pre class="screen">group</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td> +</tr> +<tr> +<td><pre class="screen">leap-username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td> +</tr> +<tr> +<td><pre class="screen">wep-key0</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Index 0 WEP key. This is the WEP key used in most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td> +</tr> +<tr> +<td><pre class="screen">wep-key1</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Index 1 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td> +</tr> +<tr> +<td><pre class="screen">wep-key2</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Index 2 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td> +</tr> +<tr> +<td><pre class="screen">wep-key3</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Index 3 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td> +</tr> +<tr> +<td><pre class="screen">wep-key-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the WEP keys. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">wep-key-type</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.</td> +</tr> +<tr> +<td><pre class="screen">psk</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</td> +</tr> +<tr> +<td><pre class="screen">psk-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the WPA PSK key. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> +<td><pre class="screen">leap-password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td> +</tr> +<tr> +<td><pre class="screen">leap-password-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the LEAP password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/right.png b/docs/api/html/right.png Binary files differnew file mode 100644 index 000000000..92832e3a4 --- /dev/null +++ b/docs/api/html/right.png diff --git a/docs/api/html/secrets-flags.html b/docs/api/html/secrets-flags.html new file mode 100644 index 000000000..ee0a78fe8 --- /dev/null +++ b/docs/api/html/secrets-flags.html @@ -0,0 +1,64 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Secret flag types</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="ref-settings.html" title="Network Configuration Setting Specification"> +<link rel="prev" href="ref-settings.html" title="Network Configuration Setting Specification"> +<link rel="next" href="ref-migrating.html" title="Migrating from NetworkManager 0.8 to NetworkManager 0.9"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-settings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ref-settings.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="ref-migrating.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="secrets-flags"></a>Secret flag types</h2></div></div></div> +<p> + Each secret property in a setting has an associated "flags" property + that describes how to handle that secret. The "flags" property is a + bitfield that contains zero or more of the following values logically + OR-ed together. + </p> +<p> + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<code class="literal">0x0 (none)</code> - the system is responsible for providing + and storing this secret. + </li> +<li class="listitem"> +<code class="literal">0x1 (agent-owned)</code> - a user-session secret agent + is responsible for providing and storing this secret; when it is + required, agents will be asked to provide it. + </li> +<li class="listitem"> +<code class="literal">0x2 (not-saved)</code> - 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. + </li> +<li class="listitem"> +<code class="literal">0x4 (not-required)</code> - 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. + </li> +</ul></div> +<p> + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html new file mode 100644 index 000000000..5a1c58d42 --- /dev/null +++ b/docs/api/html/spec.html @@ -0,0 +1,1361 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9</title><style type="text/css"> + + body { + font-family: sans-serif; + margin: 2em; + height: 100%; + font-size: 1.2em; + } + h1 { + padding-top: 5px; + padding-bottom: 5px; + font-size: 1.6em; + background: #dadae2; + } + h2 { + font-size: 1.3em; + } + h3 { + font-size: 1.2em; + } + a:link, a:visited, a:link:hover, a:visited:hover { + font-weight: bold; + } + .topbox { + padding-top: 10px; + padding-left: 10px; + border-bottom: black solid 1px; + padding-bottom: 10px; + background: #dadae2; + font-size: 2em; + font-weight: bold; + color: #5c5c5c; + } + .topnavbox { + padding-left: 10px; + padding-top: 5px; + padding-bottom: 5px; + background: #abacba; + border-bottom: black solid 1px; + font-size: 1.2em; + } + .topnavbox a{ + color: black; + font-weight: normal; + } + .sidebar { + float: left; + /* width:9em; + border-right:#abacba solid 1px; + border-left: #abacba solid 1px; + height:100%; */ + border: #abacba solid 1px; + padding-left: 10px; + margin-left: 10px; + padding-right: 10px; + margin-right: 10px; + color: #5d5d5d; + background: #dadae2; + } + .sidebar a { + text-decoration: none; + border-bottom: #e29625 dotted 1px; + color: #e29625; + font-weight: normal; + } + .sidebar h1 { + font-size: 1.2em; + color: black; + } + .sidebar ul { + padding-left: 25px; + padding-bottom: 10px; + border-bottom: #abacba solid 1px; + } + .sidebar li { + padding-top: 2px; + padding-bottom: 2px; + } + .sidebar h2 { + font-style:italic; + font-size: 0.81em; + padding-left: 5px; + padding-right: 5px; + font-weight: normal; + } + .date { + font-size: 0.6em; + float: right; + font-style: italic; + } + .method { + margin-left: 1em; + margin-right: 4em; + } + .signal { + margin-left: 1em; + margin-right: 4em; + } + + </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> +<p>This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version.</p> + +<p>This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details.</p> + +<p>You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> +</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul> + <h1><a name="org.freedesktop.NetworkManager" id="org.freedesktop.NetworkManager"></a>org.freedesktop.NetworkManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDevices" id="org.freedesktop.NetworkManager.GetDevices">GetDevices</a> ( + + ) → + ao</h3><div class="docstring"> + Get the list of network devices. + </div><div><h4>Returns</h4><dl><dt><code>devices</code> - + <code>ao</code></dt><dd> + List of object paths of network devices known to the system. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.ActivateConnection" id="org.freedesktop.NetworkManager.ActivateConnection">ActivateConnection</a> ( + o: connection, o: device, o: specific_object + ) → + o</h3><div class="docstring"> + Activate a connection using the supplied device. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>o</code></dt><dd> + The connection to activate the devices with. + </dd><dt><code>device</code> - + <code>o</code></dt><dd> + The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + </dd><dt><code>specific_object</code> - + <code>o</code></dt><dd> + The path of a connection-type-specific object this activation should use. + This parameter is currently ignored for wired and mobile broadband connections, + and the value of "/" should be used (ie, no specific object). For WiFi + connections, pass the object path of a specific AP from the card's scan + list, or "/" to pick and AP automatically. For VPN connections, pass + the object path of an ActiveConnection object that should serve as the + "base" connection (to which the VPN connections lifetime will be tied), + or pass "/" and NM will automatically use the current default device. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>active_connection</code> - + <code>o</code></dt><dd> + The path of the active connection object representing this active connection. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> + Connection was not provided by the settings service. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> + Unknown device. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionActivating</code></dt><dd>Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?</dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> ( + a{sa{sv}}: connection, o: device, o: specific_object + ) → + o, o</h3><div class="docstring"> + Adds a new connection using the given details (if any) as a template + (automatically filling in missing settings with the capabilities of the + given device and specific object), then activate the new connection. + Cannot be used for VPN connections at this time. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code></dt><dd> + Connection settings and properties; if incomplete missing settings will + be automatically completed using the given device and specific object. + </dd><dt><code>device</code> - + <code>o</code></dt><dd> + The object path of device to be activated using the given connection. + </dd><dt><code>specific_object</code> - + <code>o</code></dt><dd> + The path of a connection-type-specific object this activation should use. + This parameter is currently ignored for wired and mobile broadband connections, + and the value of "/" should be used (ie, no specific object). For WiFi + connections, pass the object path of a specific AP from the card's scan + list, which will be used to complete the details of the newly added + connection. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> - + <code>o</code></dt><dd> + Object path of the new connection that was just added. + </dd><dt><code>active_connection</code> - + <code>o</code></dt><dd> + The path of the active connection object representing this active connection. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> + Connection was not provided by the settings service. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> + Unknown device. + <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> ( + o: active_connection + ) → + nothing</h3><div class="docstring"> + Deactivate an active connection. + </div><div><h4>Parameters</h4><dl><dt><code>active_connection</code> - + <code>o</code></dt><dd> + The currently active connection to deactivate. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Sleep" id="org.freedesktop.NetworkManager.Sleep">Sleep</a> ( + b: sleep + ) → + nothing</h3><div class="docstring"> + Control the NetworkManager daemon's sleep state. When asleep, all + interfaces that it manages are deactivated. When awake, devices are + available to be activated. This command should not be called directly + by users or clients; it is intended for system suspend/resume tracking. + </div><div><h4>Parameters</h4><dl><dt><code>sleep</code> - + <code>b</code></dt><dd> + Indicates whether the NetworkManager daemon should sleep or wake. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Enable" id="org.freedesktop.NetworkManager.Enable">Enable</a> ( + b: enable + ) → + nothing</h3><div class="docstring"> + Control whether overall networking is enabled or disabled. When + disabled, all interfaces that NM manages are deactivated. When enabled, + all managed interfaces are re-enabled and available to be activated. + This command should be used by clients that provide to users the ability + to enable/disable all networking. + </div><div><h4>Parameters</h4><dl><dt><code>enable</code> - + <code>b</code></dt><dd> + If FALSE, indicates that all networking should be disabled. If TRUE, + indicates that NetworkManager should begin managing network devices. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetPermissions" id="org.freedesktop.NetworkManager.GetPermissions">GetPermissions</a> ( + + ) → + a{ss}</h3><div class="docstring"> + Returns the permissions a caller has for various authenticated operations + that NetworkManager provides, like Enable/Disable networking, changing + WiFi, WWAN, and WiMAX state, etc. + </div><div><h4>Returns</h4><dl><dt><code>permissions</code> - + <code>a{ss}</code></dt><dd> + Dictionary of available permissions and results. Each permission + is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") + and each result is one of the following values: "yes" (the permission + is available), "auth" (the permission is available after a successful + authentication), or "no" (the permission is denied). Clients may use + these values in the UI to indicate the ability to perform certain + operations. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SetLogging" id="org.freedesktop.NetworkManager.SetLogging">SetLogging</a> ( + s: level, s: domains + ) → + nothing</h3><div class="docstring"> + Set logging verbosity and which operations are logged. + </div><div><h4>Parameters</h4><dl><dt><code>level</code> - + <code>s</code></dt><dd> + One of [ERR, WARN, INFO, DEBUG]. + </dd><dt><code>domains</code> - + <code>s</code></dt><dd> + A combination of logging domains separated by commas (','), or "NONE" + to disable logging. Each domain enables logging for operations + related to that domain. Available domains are: [NONE, HW, RFKILL, + ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, + DNS, VPN, SHARING, SUPPLICANT, USER_SET, SYS_SET, SUSPEND, CORE, + DEVICE, OLPC] + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.state" id="org.freedesktop.NetworkManager.state">state</a> ( + + ) → + u</h3><div class="docstring"> + The overall networking state as determined by the NetworkManager daemon, + based on the state of network devices under it's management. + </div><div><h4>Returns</h4><dl><dt><code>state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_STATE">NM_STATE</a>) + </dt><dd></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.CheckPermissions" id="org.freedesktop.NetworkManager.CheckPermissions">CheckPermissions</a> ( + + )</h3><div class="docstring"> + Emitted when system authorization details change, indicating that + clients may wish to recheck permissions with GetPermissions. + </div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.StateChanged" id="org.freedesktop.NetworkManager.StateChanged">StateChanged</a> ( + u: state + )</h3><div class="docstring"> + NetworkManager's state changed. + </div><div><h4>Parameters</h4><dl><dt><code>state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_STATE">NM_STATE</a>) + </dt><dd> + The new state of NetworkManager. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.PropertiesChanged" id="org.freedesktop.NetworkManager.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"> + NetworkManager's properties changed. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + The changed properties. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceAdded" id="org.freedesktop.NetworkManager.DeviceAdded">DeviceAdded</a> ( + o: device_path + )</h3><div class="docstring"> + A device was added to the system + </div><div><h4>Parameters</h4><dl><dt><code>device_path</code> - + <code>o</code></dt><dd> + The object path of the newly added device. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceRemoved" id="org.freedesktop.NetworkManager.DeviceRemoved">DeviceRemoved</a> ( + o: device_path + )</h3><div class="docstring"> + A device was removed from the system, and is no longer available. + </div><div><h4>Parameters</h4><dl><dt><code>device_path</code> - + <code>o</code></dt><dd> + The object path of the device that was just removed. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>NetworkingEnabled</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates if overall networking is currently enabled or not. See the + Enable() method. + </dd><dt><code>WirelessEnabled</code> - + <code>b</code> - + <code>(readwrite)</code></dt><dd> + Indicates if wireless is currently enabled or not. + </dd><dt><code>WirelessHardwareEnabled</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch. + </dd><dt><code>WwanEnabled</code> - + <code>b</code> - + <code>(readwrite)</code></dt><dd> + Indicates if mobile broadband devices are currently enabled or not. + </dd><dt><code>WwanHardwareEnabled</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch. + </dd><dt><code>WimaxEnabled</code> - + <code>b</code> - + <code>(readwrite)</code></dt><dd> + Indicates if WiMAX devices are currently enabled or not. + </dd><dt><code>WimaxHardwareEnabled</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch. + </dd><dt><code>ActiveConnections</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + List of active connection object paths. + </dd><dt><code>Version</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + NetworkManager version. + </dd><dt><code>State</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_STATE">NM_STATE</a>) + </dt><dd> + The overall state of the NetworkManager daemon. + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_STATE" id="type-NM_STATE">NM_STATE</a></h3> + Describes the overall state of the daemon. + <dl><dt><code>NM_STATE_UNKNOWN = 0</code></dt><dd> + Networking state is unknown. + </dd><dt><code>NM_STATE_ASLEEP = 10</code></dt><dd> + Networking is inactive and all devices are disabled. + </dd><dt><code>NM_STATE_DISCONNECTED = 20</code></dt><dd> + There is no active network connection. + </dd><dt><code>NM_STATE_DISCONNECTING = 30</code></dt><dd> + Network connections are being cleaned up. + </dd><dt><code>NM_STATE_CONNECTING = 40</code></dt><dd> + A network device is connecting to a network and there is no other + available network connection. + </dd><dt><code>NM_STATE_CONNECTED_LOCAL = 50</code></dt><dd> + A network device is connected, but there is only link-local connectivity. + </dd><dt><code>NM_STATE_CONNECTED_SITE = 60</code></dt><dd> + A network device is connected, but there is only site-local connectivity. + </dd><dt><code>NM_STATE_CONNECTED_GLOBAL = 70</code></dt><dd> + A network device is connected, with global network connectivity. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.AccessPoint" id="org.freedesktop.NetworkManager.AccessPoint"></a>org.freedesktop.NetworkManager.AccessPoint</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged" id="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Flags</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a>) + </dt><dd>Flags describing the capabilities of the access point.</dd><dt><code>WpaFlags</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>) + </dt><dd>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</dd><dt><code>RsnFlags</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>) + </dt><dd>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</dd><dt><code>Ssid</code> - + <code>ay</code> - + <code>(read)</code></dt><dd>The Service Set Identifier identifying the access point.</dd><dt><code>Frequency</code> - + <code>u</code> - + <code>(read)</code></dt><dd>The radio channel frequency in use by the access point, in MHz.</dd><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The hardware address (BSSID) of the access point.</dd><dt><code>Mode</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>) + </dt><dd>Describes the operating mode of the access point.</dd><dt><code>MaxBitrate</code> - + <code>u</code> - + <code>(read)</code></dt><dd>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</dd><dt><code>Strength</code> - + <code>y</code> - + <code>(read)</code></dt><dd>The current signal quality of the access point, in percent.</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_AP_FLAGS" id="type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></h3> + Flags describing the general capabilities of the access point. + <dl><dt><code>NM_802_11_AP_FLAGS_NONE = 0x0</code></dt><dd>Null capability - says nothing about the access point.</dd><dt><code>NM_802_11_AP_FLAGS_PRIVACY = 0x1</code></dt><dd>Access point supports privacy measures.</dd></dl><h3 xmlns=""><a name="type-NM_802_11_AP_SEC" id="type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></h3> + Flags describing the security capabilities of the access point. + <dl><dt><code>NM_802_11_AP_SEC_NONE = 0x0</code></dt><dd>Null flag.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP40 = 0x1</code></dt><dd>Access point supports pairwise 40-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP104 = 0x2</code></dt><dd>Access point supports pairwise 104-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_TKIP = 0x4</code></dt><dd>Access point supports pairwise TKIP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_CCMP = 0x8</code></dt><dd>Access point supports pairwise CCMP encryption.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP40 = 0x10</code></dt><dd>Access point supports a group 40-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP104 = 0x20</code></dt><dd>Access point supports a group 104-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_TKIP = 0x40</code></dt><dd>Access point supports a group TKIP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_CCMP = 0x80</code></dt><dd>Access point supports a group CCMP cipher.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100</code></dt><dd>Access point supports PSK key management.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200</code></dt><dd>Access point supports 802.1x key management.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device" id="org.freedesktop.NetworkManager.Device"></a>org.freedesktop.NetworkManager.Device</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Disconnect" id="org.freedesktop.NetworkManager.Device.Disconnect">Disconnect</a> ( + + ) → + nothing</h3><div class="docstring"> + Disconnects a device and prevents the device from automatically activating further connections without user intervention. + </div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.StateChanged" id="org.freedesktop.NetworkManager.Device.StateChanged">StateChanged</a> ( + u: new_state, u: old_state, u: reason + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>new_state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>) + </dt><dd> + The new state of the device. + </dd><dt><code>old_state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>) + </dt><dd> + The previous state of the device. + </dd><dt><code>reason</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a>) + </dt><dd> + A reason for the state transition. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Udi</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Operating-system specific transient device hardware identifier. This + is an opaque string representing the underlying hardware for the device, + and shouldn't be used to keep track of individual devices. For some + device types (Bluetooth, Modems) it is an identifier used by the + hardware service (ie bluez or ModemManager) to refer to that device, + and client programs use it get additional information from those + services which NM does not provide. The Udi is not guaranteed to be + consistent across reboots or hotplugs of the hardware. If you're looking + for a way to uniquely track each device in your application, use the + object path. If you're looking for a way to track a specific piece of + hardware across reboot or hotplug, use a MAC address or USB serial + number. + </dd><dt><code>Interface</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The name of the device's control (and often data) interface. + </dd><dt><code>IpInterface</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The name of the device's data interface when available. This property + may not refer to the actual data interface until the device has + successfully established a data connection, indicated by the device's + State becoming ACTIVATED. + </dd><dt><code>Driver</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The driver handling the device. + </dd><dt><code>Capabilities</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a>) + </dt><dd> + Flags describing the capabilities of the device. + </dd><dt><code>Ip4Address</code> - + <code>i</code> - + <code>(read)</code></dt><dd> + The IPv4 address bound to the device. FIXME: what about devices with >1 IP address? + </dd><dt><code>State</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>) + </dt><dd> + The current state of the device. + </dd><dt><code>Ip4Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. + </dd><dt><code>Dhcp4Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. + </dd><dt><code>Ip6Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state. + </dd><dt><code>Dhcp6Config</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the Dhcp6Config object describing the DHCP options + returned by the DHCP server. Only valid when the device is in the + NM_DEVICE_STATE_ACTIVATED state. + </dd><dt><code>Managed</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Whether or not this device is managed by NetworkManager. + </dd><dt><code>FirmwareMissing</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + If TRUE, indicates the device is likely missing firmware necessary for + its operation. + </dd><dt><code>DeviceType</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a>) + </dt><dd> + The general type of the network device; ie Ethernet, WiFi, etc. + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_DEVICE_STATE" id="type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></h3><dl><dt><code>NM_DEVICE_STATE_UNKNOWN = 0</code></dt><dd> + The device is in an unknown state. + </dd><dt><code>NM_DEVICE_STATE_UNMANAGED = 10</code></dt><dd> + The device is recognized but not managed by NetworkManager. + </dd><dt><code>NM_DEVICE_STATE_UNAVAILABLE = 20</code></dt><dd> + The device cannot be used (carrier off, rfkill, etc). + </dd><dt><code>NM_DEVICE_STATE_DISCONNECTED = 30</code></dt><dd> + The device is not connected. + </dd><dt><code>NM_DEVICE_STATE_PREPARE = 40</code></dt><dd> + The device is preparing to connect. + </dd><dt><code>NM_DEVICE_STATE_CONFIG = 50</code></dt><dd> + The device is being configured. + </dd><dt><code>NM_DEVICE_STATE_NEED_AUTH = 60</code></dt><dd> + The device is awaiting secrets necessary to continue connection. + </dd><dt><code>NM_DEVICE_STATE_IP_CONFIG = 70</code></dt><dd> + The IP settings of the device are being requested and configured. + </dd><dt><code>NM_DEVICE_STATE_IP_CHECK = 80</code></dt><dd> + The device's IP connectivity ability is being determined. + </dd><dt><code>NM_DEVICE_STATE_SECONDARIES = 90</code></dt><dd> + The device is waiting for secondary connections to be activated. + </dd><dt><code>NM_DEVICE_STATE_ACTIVATED = 100</code></dt><dd> + The device is active. + </dd><dt><code>NM_DEVICE_STATE_DEACTIVATING = 110</code></dt><dd> + The device's network connection is being torn down. + </dd><dt><code>NM_DEVICE_STATE_FAILED = 120</code></dt><dd> + The device is in a failure state following an attempt to activate it. + </dd></dl><h3><a name="type-NM_DEVICE_TYPE" id="type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></h3><dl><dt><code>NM_DEVICE_TYPE_UNKNOWN = 0</code></dt><dd> + The device type is unknown. + </dd><dt><code>NM_DEVICE_TYPE_ETHERNET = 1</code></dt><dd> + The device is wired Ethernet device. + </dd><dt><code>NM_DEVICE_TYPE_WIFI = 2</code></dt><dd> + The device is an 802.11 WiFi device. + </dd><dt><code>NM_DEVICE_TYPE_UNUSED1 = 3</code></dt><dd>Unused</dd><dt><code>NM_DEVICE_TYPE_UNUSED2 = 4</code></dt><dd>Unused</dd><dt><code>NM_DEVICE_TYPE_BT = 5</code></dt><dd> + The device is Bluetooth device that provides PAN or DUN capabilities. + </dd><dt><code>NM_DEVICE_TYPE_OLPC_MESH = 6</code></dt><dd> + The device is an OLPC mesh networking device. + </dd><dt><code>NM_DEVICE_TYPE_WIMAX = 7</code></dt><dd> + The device is an 802.16e Mobile WiMAX device. + </dd><dt><code>NM_DEVICE_TYPE_MODEM = 8</code></dt><dd> + The device is a modem supporting one or more of analog telephone, + CDMA/EVDO, GSM/UMTS/HSPA, or LTE standards to access a cellular or + wireline data network. + </dd></dl><h3><a name="type-NM_DEVICE_STATE_REASON" id="type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></h3><dl><dt><code>NM_DEVICE_STATE_REASON_UNKNOWN = 0</code></dt><dd> + The reason for the device state change is unknown. + </dd><dt><code>NM_DEVICE_STATE_REASON_NONE = 1</code></dt><dd> + The state change is normal. + </dd><dt><code>NM_DEVICE_STATE_REASON_NOW_MANAGED = 2</code></dt><dd> + The device is now managed. + </dd><dt><code>NM_DEVICE_STATE_REASON_NOW_UNMANAGED = 3</code></dt><dd> + The device is no longer managed. + </dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_FAILED = 4</code></dt><dd> + The device could not be readied for configuration. + </dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_UNAVAILABLE = 5</code></dt><dd> + IP configuration could not be reserved (no available address, timeout, etc). + </dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_EXPIRED = 6</code></dt><dd> + The IP configuration is no longer valid. + </dd><dt><code>NM_DEVICE_STATE_REASON_NO_SECRETS = 7</code></dt><dd> + Secrets were required, but not provided. + </dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT = 8</code></dt><dd> + The 802.1X supplicant disconnected from the access point or authentication server. + </dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED = 9</code></dt><dd> + Configuration of the 802.1X supplicant failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED = 10</code></dt><dd> + The 802.1X supplicant quit or failed unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT = 11</code></dt><dd> + The 802.1X supplicant took too long to authenticate. + </dd><dt><code>NM_DEVICE_STATE_REASON_PPP_START_FAILED = 12</code></dt><dd> + The PPP service failed to start within the allowed time. + </dd><dt><code>NM_DEVICE_STATE_REASON_PPP_DISCONNECT = 13</code></dt><dd> + The PPP service disconnected unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_PPP_FAILED = 14</code></dt><dd> + The PPP service quit or failed unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_START_FAILED = 15</code></dt><dd> + The DHCP service failed to start within the allowed time. + </dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_ERROR = 16</code></dt><dd> + The DHCP service reported an unexpected error. + </dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_FAILED = 17</code></dt><dd> + The DHCP service quit or failed unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_START_FAILED = 18</code></dt><dd> + The shared connection service failed to start. + </dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_FAILED = 19</code></dt><dd> + The shared connection service quit or failed unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED = 20</code></dt><dd> + The AutoIP service failed to start. + </dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_ERROR = 21</code></dt><dd> + The AutoIP service reported an unexpected error. + </dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_FAILED = 22</code></dt><dd> + The AutoIP service quit or failed unexpectedly. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_BUSY = 23</code></dt><dd> + Dialing failed because the line was busy. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE = 24</code></dt><dd> + Dialing failed because there was no dial tone. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER = 25</code></dt><dd> + Dialing failed because there was carrier. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT = 26</code></dt><dd> + Dialing timed out. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED = 27</code></dt><dd> + Dialing failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED = 28</code></dt><dd> + Modem initialization failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_APN_FAILED = 29</code></dt><dd> + Failed to select the specified GSM APN. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING = 30</code></dt><dd> + Not searching for networks. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED = 31</code></dt><dd> + Network registration was denied. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT = 32</code></dt><dd> + Network registration timed out. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED = 33</code></dt><dd> + Failed to register with the requested GSM network. + </dd><dt><code>NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED = 34</code></dt><dd> + PIN check failed. + </dd><dt><code>NM_DEVICE_STATE_REASON_FIRMWARE_MISSING = 35</code></dt><dd> + Necessary firmware for the device may be missing. + </dd><dt><code>NM_DEVICE_STATE_REASON_REMOVED = 36</code></dt><dd> + The device was removed. + </dd><dt><code>NM_DEVICE_STATE_REASON_SLEEPING = 37</code></dt><dd> + NetworkManager went to sleep. + </dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_REMOVED = 38</code></dt><dd> + The device's active connection was removed or disappeared. + </dd><dt><code>NM_DEVICE_STATE_REASON_USER_REQUESTED = 39</code></dt><dd> + A user or client requested the disconnection. + </dd><dt><code>NM_DEVICE_STATE_REASON_CARRIER = 40</code></dt><dd> + The device's carrier/link changed. + </dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED = 41</code></dt><dd> + The device's existing connection was assumed. + </dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE = 42</code></dt><dd> + The 802.1x supplicant is now available. + </dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND = 43</code></dt><dd> + The modem could not be found. + </dd><dt><code>NM_DEVICE_STATE_REASON_BT_FAILED = 44</code></dt><dd> + The Bluetooth connection timed out or failed. + </dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_CAP" id="type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></h3><dl><dt><code>NM_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability.</dd><dt><code>NM_DEVICE_CAP_NM_SUPPORTED = 0x1</code></dt><dd>The device is supported by NetworkManager.</dd><dt><code>NM_DEVICE_CAP_CARRIER_DETECT = 0x2</code></dt><dd>The device supports carrier detection.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.Wired" id="org.freedesktop.NetworkManager.Device.Wired"></a>org.freedesktop.NetworkManager.Device.Wired</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Active hardware address of the device. + </dd><dt><code>PermHwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Permanent hardware address of the device. + </dd><dt><code>Speed</code> - + <code>u</code> - + <code>(read)</code></dt><dd> + Design speed of the device, in megabits/second (Mb/s). + </dd><dt><code>Carrier</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.Wireless" id="org.freedesktop.NetworkManager.Device.Wireless"></a>org.freedesktop.NetworkManager.Device.Wireless</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints" id="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints">GetAccessPoints</a> ( + + ) → + ao</h3><div class="docstring"> + Get the list of access points visible to this device. + </div><div><h4>Returns</h4><dl><dt><code>access_points</code> - + <code>ao</code></dt><dd> + List of access point object paths + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"> + Emitted when the wireless device's properties changed. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary containing the FIXME: check changed parameters. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded">AccessPointAdded</a> ( + o: access_point + )</h3><div class="docstring"> + Emitted when a new access point is found by the device. + </div><div><h4>Parameters</h4><dl><dt><code>access_point</code> - + <code>o</code></dt><dd> + The object path of the newly found access point. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved">AccessPointRemoved</a> ( + o: access_point + )</h3><div class="docstring"> + Emitted when an access point disappears from view of the device. + </div><div><h4>Parameters</h4><dl><dt><code>access_point</code> - + <code>o</code></dt><dd> + The object path of the access point that has disappeared. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The active hardware address of the device. + </dd><dt><code>PermHwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The permanent hardware address of the device. + </dd><dt><code>Mode</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>) + </dt><dd> + The operating mode of the wireless device. + </dd><dt><code>Bitrate</code> - + <code>u</code> - + <code>(read)</code></dt><dd> + The bit rate currently used by the wireless device, in kilobits/second (Kb/s). + </dd><dt><code>ActiveAccessPoint</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the access point currently used by the wireless device. + </dd><dt><code>WirelessCapabilities</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a>) + </dt><dd> + The capabilities of the wireless device. + </dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_DEVICE_CAP" id="type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></h3> + Flags describing the capabilities of a wireless device. + <dl><dt><code>NM_802_11_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1</code></dt><dd>The device supports the 40-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2</code></dt><dd>The device supports the 104-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4</code></dt><dd>The device supports the TKIP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8</code></dt><dd>The device supports the CCMP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_WPA = 0x10</code></dt><dd>The device supports the WPA encryption/authentication protocol.</dd><dt><code>NM_802_11_DEVICE_CAP_RSN = 0x20</code></dt><dd>The device supports the RSN encryption/authentication protocol.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.Modem" id="org.freedesktop.NetworkManager.Device.Modem"></a>org.freedesktop.NetworkManager.Device.Modem</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Modem.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Modem.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>ModemCapabilities</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a>) + </dt><dd> + The generic family of access technologies the modem supports. Not all + capabilities are available at the same time however; some modems require + a firmware reload or other reinitialization to switch between eg CDMA/EVDO + and GSM/UMTS. + </dd><dt><code>CurrentCapabilities</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a>) + </dt><dd> + The generic family of access technologies the modem currently supports + without a firmware reload or reinitialization. + </dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_MODEM_CAPABILITIES" id="type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a></h3> + Flags describing one or more of the general access technology families + that a modem device supports. + <dl><dt><code>NM_DEVICE_MODEM_CAPABILITY_NONE = 0x0</code></dt><dd>Modem has no capabilties.</dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_POTS = 0x1</code></dt><dd> + Modem supports the analog wired telephone network (ie 56k dialup) and + does not have wireless/cellular capabilities. + </dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO = 0x2</code></dt><dd> + Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO + revision A, or EVDO revision B. + </dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS = 0x4</code></dt><dd> + Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or + HSPA+ packet switched data capability. + </dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_LTE = 0x8</code></dt><dd> + Modem has at LTE data capability. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.Bluetooth" id="org.freedesktop.NetworkManager.Device.Bluetooth"></a>org.freedesktop.NetworkManager.Device.Bluetooth</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Bluetooth hardware address of the device. + </dd><dt><code>Name</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Bluetooth name of the device. + </dd><dt><code>BtCapabilities</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a>) + </dt><dd> + Bluetooth capabilities of the device (either DUN or NAP). + </dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_BT_CAPABILITIES" id="type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></h3> + Flags describing the capabilities of a Bluetooth device. + <dl><dt><code>NM_BT_CAPABILITY_NONE = 0x0</code></dt><dd>The device has no recognized capabilities.</dd><dt><code>NM_BT_CAPABILITY_DUN = 0x1</code></dt><dd>The device supports Bluetooth Dial-Up Networking.</dd><dt><code>NM_BT_CAPABILITY_PAN = 0x2</code></dt><dd>The device supports Bluetooth Personal Area Networking.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.OlpcMesh" id="org.freedesktop.NetworkManager.Device.OlpcMesh"></a>org.freedesktop.NetworkManager.Device.OlpcMesh</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"> + Emitted when the wireless device's properties changed. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary containing the FIXME: check changed parameters. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The hardware address of the device. + </dd><dt><code>Companion</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + The object path of the companion device. + </dd><dt><code>ActiveChannel</code> - + <code>u</code> - + <code>(read)</code></dt><dd> + The currently active channel. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Device.WiMax" id="org.freedesktop.NetworkManager.Device.WiMax"></a>org.freedesktop.NetworkManager.Device.WiMax</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.GetNspList" id="org.freedesktop.NetworkManager.Device.WiMax.GetNspList">GetNspList</a> ( + + ) → + ao</h3><div class="docstring"> + Get the list of NSPs visible to this device. + </div><div><h4>Returns</h4><dl><dt><code>nsps</code> - + <code>ao</code></dt><dd> + List of NSP object paths + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.WiMax.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"> + Emitted when the WiMax device's properties changed. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.NspAdded" id="org.freedesktop.NetworkManager.Device.WiMax.NspAdded">NspAdded</a> ( + o: nsp + )</h3><div class="docstring"> + Emitted when a new NSP is found by the device. + </div><div><h4>Parameters</h4><dl><dt><code>nsp</code> - + <code>o</code></dt><dd> + The object path of the newly found NSP. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.NspRemoved" id="org.freedesktop.NetworkManager.Device.WiMax.NspRemoved">NspRemoved</a> ( + o: nsp + )</h3><div class="docstring"> + Emitted when an NSP disappears from view of the device. + </div><div><h4>Parameters</h4><dl><dt><code>nsp</code> - + <code>o</code></dt><dd> + The object path of the NSP that has disappeared. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + Hardware address of the device. + </dd><dt><code>CenterFrequency</code> - + <code>u</code> - + <code>(read)</code></dt><dd> + Center frequency (in KHz) of the radio channel the device is using to + communicate with the network when connected. Has no meaning when the + device is not connected. + </dd><dt><code>Rssi</code> - + <code>i</code> - + <code>(read)</code></dt><dd> + RSSI of the current radio link in dBm. This value indicates how strong + the raw received RF signal from the base station is, but does not + indicate the overall quality of the radio link. Has no meaning when the + device is not connected. + </dd><dt><code>Cinr</code> - + <code>i</code> - + <code>(read)</code></dt><dd> + CINR (Carrier to Interference + Noise Ratio) of the current radio link + in dB. CINR is a more accurate measure of radio link quality. Has no + meaning when the device is not connected. + </dd><dt><code>TxPower</code> - + <code>i</code> - + <code>(read)</code></dt><dd> + Average power of the last burst transmitted by the device, in units of + 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of + -5.5 dBm. Has no meaning when the device is not connected. + </dd><dt><code>Bsid</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The ID of the serving base station as received from the network. Has + no meaning when the device is not connected. + </dd><dt><code>ActiveNsp</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the NSP currently used by the WiMax device. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.WiMax.Nsp" id="org.freedesktop.NetworkManager.WiMax.Nsp"></a>org.freedesktop.NetworkManager.WiMax.Nsp</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.WiMax.Nsp.PropertiesChanged" id="org.freedesktop.NetworkManager.WiMax.Nsp.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Name</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The name of the NSP.</dd><dt><code>SignalQuality</code> - + <code>u</code> - + <code>(read)</code></dt><dd>The current signal quality of the NSP, in percent.</dd><dt><code>NetworkType</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a>) + </dt><dd>The network type of the NSP.</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_WIMAX_NSP_NETWORK_TYPE" id="type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></h3> + Network type of the NSP. + <dl><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0x0</code></dt><dd>Unknown network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_HOME = 0x1</code></dt><dd>Home network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 0x2</code></dt><dd>Partner network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 0x3</code></dt><dd>Roaming partner network.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.IP4Config" id="org.freedesktop.NetworkManager.IP4Config"></a>org.freedesktop.NetworkManager.IP4Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> - + <code>aau</code> - + <code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3 + elements of each tuple are in network byte order. Essentially: + [(addr, prefix, gateway), (addr, prefix, gateway), ...] + </dd><dt><code>Nameservers</code> - + <code>au</code> - + <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>WinsServers</code> - + <code>au</code> - + <code>(read)</code></dt><dd>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</dd><dt><code>Domains</code> - + <code>as</code> - + <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> - + <code>aau</code> - + <code>(read)</code></dt><dd>Tuples of IPv4 route/prefix/next-hop/metric. All 4 elements + of each tuple are in network byte order. 'route' and 'next hop' are IPv4 + addresses, while prefix and metric are simple unsigned integers. Essentially: + [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...] + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.IP6Config" id="org.freedesktop.NetworkManager.IP6Config"></a>org.freedesktop.NetworkManager.IP6Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> - + <code>a(ayuay)</code> - + <code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Nameservers</code> - + <code>aay</code> - + <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - + <code>as</code> - + <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> - + <code>a(ayuayu)</code> - + <code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.DHCP4Config" id="org.freedesktop.NetworkManager.DHCP4Config"></a>org.freedesktop.NetworkManager.DHCP4Config</h1> + Options and configuration returned by the IPv4 DHCP server. + <p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> - + <code>a{sv}</code> - + <code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.DHCP6Config" id="org.freedesktop.NetworkManager.DHCP6Config"></a>org.freedesktop.NetworkManager.DHCP6Config</h1> + Options and configuration returned by the IPv6 DHCP server. + <p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> - + <code>a{sv}</code> - + <code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.Settings" id="org.freedesktop.NetworkManager.Settings"></a>org.freedesktop.NetworkManager.Settings</h1> + The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager. + <h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.ListConnections" id="org.freedesktop.NetworkManager.Settings.ListConnections">ListConnections</a> ( + + ) → + ao</h3><div class="docstring"> + List the connections stored by this Settings object. + </div><div><h4>Returns</h4><dl><dt><code>connections</code> - + <code>ao</code></dt><dd> + List of connections. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.AddConnection" id="org.freedesktop.NetworkManager.Settings.AddConnection">AddConnection</a> ( + a{sa{sv}}: connection + ) → + o</h3><div class="docstring"> + Add new connection. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code></dt><dd> + Connection settings and properties. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> - + <code>o</code></dt><dd> + Object path of the new connection that was just added. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.SaveHostname" id="org.freedesktop.NetworkManager.Settings.SaveHostname">SaveHostname</a> ( + s: hostname + ) → + nothing</h3><div class="docstring"> + Save the hostname to persistent configuration. + </div><div><h4>Parameters</h4><dl><dt><code>hostname</code> - + <code>s</code></dt><dd> + The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.PropertiesChanged" id="org.freedesktop.NetworkManager.Settings.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.NewConnection" id="org.freedesktop.NetworkManager.Settings.NewConnection">NewConnection</a> ( + o: connection + )</h3><div class="docstring"> + Emitted when a new connection has been added. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>o</code></dt><dd> + Object path of the new connection. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Hostname</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + The machine hostname stored in persistent configuration. + </dd><dt><code>CanModify</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + If true, adding and modifying connections is supported. + </dd></dl> + + + <h1><a name="org.freedesktop.NetworkManager.Settings.Connection" id="org.freedesktop.NetworkManager.Settings.Connection"></a>org.freedesktop.NetworkManager.Settings.Connection</h1> + Represents a single network connection configuration. + <h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Update" id="org.freedesktop.NetworkManager.Settings.Connection.Update">Update</a> ( + a{sa{sv}}: properties + ) → + nothing</h3><div class="docstring"> + Update the connection with new settings and properties, replacing + all previous settings and properties. Secrets may be part of the + update request, and will be either stored in persistent storage or + given to a Secret Agent for storage, depending on the request. + </div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sa{sv}}</code></dt><dd> + New connection settings, properties, and (optionally) secrets. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Delete" id="org.freedesktop.NetworkManager.Settings.Connection.Delete">Delete</a> ( + + ) → + nothing</h3><div class="docstring"> + Delete the connection. + </div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.GetSettings" id="org.freedesktop.NetworkManager.Settings.Connection.GetSettings">GetSettings</a> ( + + ) → + a{sa{sv}}</h3><div class="docstring"> + Get the settings maps describing this network configuration. + This will never include any secrets required for connection + to the network, as those are often protected. Secrets must + be requested separately using the GetSecrets() call. + </div><div><h4>Returns</h4><dl><dt><code>settings</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + The nested settings maps describing this object. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.GetSecrets" id="org.freedesktop.NetworkManager.Settings.Connection.GetSecrets">GetSecrets</a> ( + s: setting_name + ) → + a{sa{sv}}</h3><div class="docstring"> + Get the secrets belonging to this network configuration. Only + secrets from persistent storage or a Secret Agent running in + the requestor's session will be returned. The user will never + be prompted for secrets as a result of this request. + </div><div><h4>Parameters</h4><dl><dt><code>setting_name</code> - + <code>s</code></dt><dd> + Name of the setting to return secrets for. If empty, all + all secrets will be returned. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>secrets</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + Nested settings maps containing secrets. + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Updated" id="org.freedesktop.NetworkManager.Settings.Connection.Updated">Updated</a> ( + + )</h3><div class="docstring"> + Emitted when any settings or permissions change. When handling + this signal, clients should re-read the connection using the + GetSettings method to get the changes and to ensure the client + still has permission to access the connection. + </div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Removed" id="org.freedesktop.NetworkManager.Settings.Connection.Removed">Removed</a> ( + + )</h3><div class="docstring"> + Emitted when this connection is no longer available. This + happens when the connection is deleted or if it is no longer + accessable by any of the system's logged-in users. After + receipt of this signal, the object no longer exists. + </div></div><p>Interface has no properties.</p> + + + <h1><a name="org.freedesktop.NetworkManager.Connection.Active" id="org.freedesktop.NetworkManager.Connection.Active"></a>org.freedesktop.NetworkManager.Connection.Active</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged" id="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Connection</code> - + <code>o</code> - + <code>(read)</code></dt><dd>The path of the connection.</dd><dt><code>SpecificObject</code> - + <code>o</code> - + <code>(read)</code></dt><dd>A specific object associated with the active connection.</dd><dt><code>Devices</code> - + <code>ao</code> - + <code>(read)</code></dt><dd>Array of object paths representing devices which are part of this active connection.</dd><dt><code>State</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a>) + </dt><dd>The state of this active connection.</dd><dt><code>Default</code> - + <code>b</code> - + <code>(read)</code></dt><dd>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</dd><dt><code>Default6</code> - + <code>b</code> - + <code>(read)</code></dt><dd>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</dd><dt><code>Vpn</code> - + <code>b</code> - + <code>(read)</code></dt><dd>Whether this active connection is also a VPN connection.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_ACTIVE_CONNECTION_STATE" id="type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></h3><dl><dt><code>NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd> + The active connection is in an unknown state. + </dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1</code></dt><dd> + The connection is activating. + </dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATED = 2</code></dt><dd> + The connection is activated. + </dd><dt><code>NM_ACTIVE_CONNECTION_STATE_DEACTIVATING = 3</code></dt><dd> + The connection is being torn down and cleaned up. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.AgentManager" id="org.freedesktop.NetworkManager.AgentManager"></a>org.freedesktop.NetworkManager.AgentManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.Register" id="org.freedesktop.NetworkManager.AgentManager.Register">Register</a> ( + s: identifier + ) → + nothing</h3><div class="docstring"> + Called by secret Agents to register their ability to provide and save + network secrets. + </div><div><h4>Parameters</h4><dl><dt><code>identifier</code> - + <code>s</code></dt><dd> + Identifies this agent; only one agent in each user session may use the + same identifier. Identifier formatting follows the same rules as + D-Bus bus names with the exception that the ':' character is not + allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the + identifier is limited in length to 255 characters with a minimum + of 3 characters. An example valid identifier is 'org.gnome.nm-applet' + (without quotes). + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.Unregister" id="org.freedesktop.NetworkManager.AgentManager.Unregister">Unregister</a> ( + + ) → + nothing</h3><div class="docstring"> + Called by secret Agents to notify NetworkManager that they will no + longer handle requests for network secrets. Agents are automatically + unregistered when they disconnect from D-Bus. + </div></div><p>Interface has no signals.</p><p>Interface has no properties.</p> + + <h1><a name="org.freedesktop.NetworkManager.VPN.Connection" id="org.freedesktop.NetworkManager.VPN.Connection"></a>org.freedesktop.NetworkManager.VPN.Connection</h1> + Represents an active connection to a Virtual Private Network. + <p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged" id="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged">PropertiesChanged</a> ( + a{sv}: properties + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + A dictionary mapping property names to variant boxed values + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged" id="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged">VpnStateChanged</a> ( + u: state, u: reason + )</h3><div class="docstring"> + Emitted when the state of the VPN connection has changed. + </div><div><h4>Parameters</h4><dl><dt><code>state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + </dt><dd> + The new state of the VPN connection. + </dd><dt><code>reason</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a>) + </dt><dd> + Reason code describing the change to the new state. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>VpnState</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + </dt><dd>The VPN-specific state of the connection.</dd><dt><code>Banner</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The banner string of the VPN connection.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_CONNECTION_STATE" id="type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd> + The state of the VPN connection is unknown. + </dd><dt><code>NM_VPN_CONNECTION_STATE_PREPARE = 1</code></dt><dd> + The VPN connection is preparing to connect. + </dd><dt><code>NM_VPN_CONNECTION_STATE_NEED_AUTH = 2</code></dt><dd> + The VPN connection needs authorization credentials. + </dd><dt><code>NM_VPN_CONNECTION_STATE_CONNECT = 3</code></dt><dd> + The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED. + </dd><dt><code>NM_VPN_CONNECTION_STATE_IP_CONFIG_GET = 4</code></dt><dd> + The VPN connection is getting an IP address. FIXME: Should be an -ING + </dd><dt><code>NM_VPN_CONNECTION_STATE_ACTIVATED = 5</code></dt><dd> + The VPN connection is active. + </dd><dt><code>NM_VPN_CONNECTION_STATE_FAILED = 6</code></dt><dd> + The VPN connection failed. + </dd><dt><code>NM_VPN_CONNECTION_STATE_DISCONNECTED = 7</code></dt><dd> + The VPN connection is disconnected. + </dd></dl><h3><a name="type-NM_VPN_CONNECTION_STATE_REASON" id="type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0</code></dt><dd> + The reason for the VPN connection state change is unknown. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NONE = 1</code></dt><dd> + No reason was given for the VPN connection state change. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED = 2</code></dt><dd> + The VPN connection changed state because the user disconnected it. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED = 3</code></dt><dd> + The VPN connection changed state because the device it was using was disconnected. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED = 4</code></dt><dd> + The service providing the VPN connection was stopped. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID = 5</code></dt><dd> + The IP config of the VPN connection was invalid. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT = 6</code></dt><dd> + The connection attempt to the VPN service timed out. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT = 7</code></dt><dd> + A timeout occurred while starting the service providing the VPN connection. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED = 8</code></dt><dd> + Starting the service starting the service providing the VPN connection failed. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS = 9</code></dt><dd> + Necessary secrets for the VPN connection were not provided. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED = 10</code></dt><dd> + Authentication to the VPN server failed. + </dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED = 11</code></dt><dd> + The connection was deleted from settings. + </dd></dl> + + <h1><a name="org.freedesktop.NetworkManager.VPN.Plugin" id="org.freedesktop.NetworkManager.VPN.Plugin"></a>org.freedesktop.NetworkManager.VPN.Plugin</h1> + This interface is provided by plugins providing VPN services to the NetworkManager daemon. + <h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Connect" id="org.freedesktop.NetworkManager.VPN.Plugin.Connect">Connect</a> ( + a{sa{sv}}: connection + ) → + nothing</h3><div class="docstring"> + Tells the plugin to connect. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + Describes the connection to be established. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being started.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd>The request could not be processed because a VPN connection was already active.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>Invalid arguments were passed with the request. FIXME: too general.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>A binary providing the service failed to launch.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets">NeedSecrets</a> ( + a{sa{sv}}: settings + ) → + s</h3><div class="docstring"> + Asks the plugin whether the provided connection will require secrets to connect successfully. + </div><div><h4>Parameters</h4><dl><dt><code>settings</code> - + <code>a{sa{sv}}</code> + (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) + </dt><dd> + Describes the connection that may need secrets. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>setting_name</code> - + <code>s</code></dt><dd> + The setting name within the provided connection that requires secrets, if any. + </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</code></dt><dd>The request could not be processed because the VPN connection settings were invalid.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect" id="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect">Disconnect</a> ( + + ) → + nothing</h3><div class="docstring"> + Disconnect the plugin. + </div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</code></dt><dd>The request could not be processed because the VPN connection was already stopped.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config">SetIp4Config</a> ( + a{sv}: config + ) → + nothing</h3><div class="docstring"> + Set IPv4 details on the connection. + </div><div><h4>Parameters</h4><dl><dt><code>config</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + Ip4Config details for the conneciton. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure" id="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure">SetFailure</a> ( + s: reason + ) → + nothing</h3><div class="docstring"> + Indicate a failure to the plugin. + </div><div><h4>Parameters</h4><dl><dt><code>reason</code> - + <code>s</code></dt><dd> + The reason for the failure. + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged" id="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged">StateChanged</a> ( + u: state + )</h3><div class="docstring"> + Emitted when the plugin state changes. + </div><div><h4>Parameters</h4><dl><dt><code>state</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + </dt><dd> + The new state of the plugin. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config">Ip4Config</a> ( + a{sv}: ip4config + )</h3><div class="docstring"> + The plugin obtained an IPv4 configuration. + </div><div><h4>Parameters</h4><dl><dt><code>ip4config</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd> + The IPv4 configuration. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner" id="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner">LoginBanner</a> ( + s: banner + )</h3><div class="docstring"> + Emitted when the plugin receives a login banner from the VPN service. + </div><div><h4>Parameters</h4><dl><dt><code>banner</code> - + <code>s</code></dt><dd> + The login banner string. + </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Failure" id="org.freedesktop.NetworkManager.VPN.Plugin.Failure">Failure</a> ( + u: reason + )</h3><div class="docstring"> + Emitted when a failure in the VPN plugin occurs. + </div><div><h4>Parameters</h4><dl><dt><code>reason</code> - + <code>u</code> + (<a xmlns="" href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a>) + </dt><dd> + Reason code for the failure. + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>State</code> - + <code>u</code> - + <code>(read)</code> + (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + </dt><dd> + The state of the plugin. + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd> + Login failed. + </dd><dt><code>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1</code></dt><dd> + Connect failed. + </dd><dt><code>NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG = 2</code></dt><dd> + Invalid IP configuration returned from the VPN plugin. + </dd></dl> +<h1>Generic types:</h1><h2>Enumerated types:</h2><h3><a name="type-NM_802_11_MODE" id="type-NM_802_11_MODE">NM_802_11_MODE</a></h3><dl><dt><code>NM_802_11_MODE_UNKNOWN = 0</code></dt><dd>Mode is unknown.</dd><dt><code>NM_802_11_MODE_ADHOC = 1</code></dt><dd>Uncoordinated network without central infrastructure.</dd><dt><code>NM_802_11_MODE_INFRA = 2</code></dt><dd>Coordinated network with one or more central controllers.</dd></dl><h2>Mapping types:</h2><div class="struct"><h3><a name="type-String_Variant_Map" id="type-String_Variant_Map">String_Variant_Map</a> - a{ + s: Key → v: Value + } + </h3><div class="docstring">A mapping from strings to variants representing extra + key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> - + <code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> - + <code>v</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Map" id="type-String_String_Map">String_String_Map</a> - a{ + s: Key → s: Value + } + </h3><div class="docstring">A mapping from strings to strings representing extra + key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> - + <code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> - + <code>s</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Variant_Map_Map" id="type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a> - a{ + s: Key → a{sv}: Value + } + </h3><div class="docstring">A mapping from strings to a map of string to variant.</div><div><h4>Members</h4><dl><dt><code>Key</code> - + <code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> - + <code>a{sv}</code> + (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) + </dt><dd><em>(undocumented)</em></dd></dl></div></div><h1>Errors:</h1> + + + <h2><a name="org.freedesktop.NetworkManager.Error.UnknownConnection" id="org.freedesktop.NetworkManager.Error.UnknownConnection"></a>org.freedesktop.NetworkManager.Error.UnknownConnection</h2> + Connection was not provided by the settings service. + + + <h2><a name="org.freedesktop.NetworkManager.Error.UnknownDevice" id="org.freedesktop.NetworkManager.Error.UnknownDevice"></a>org.freedesktop.NetworkManager.Error.UnknownDevice</h2> + Unknown device. + + + <h2><a name="org.freedesktop.NetworkManager.Error.PermissionDenied" id="org.freedesktop.NetworkManager.Error.PermissionDenied"></a>org.freedesktop.NetworkManager.Error.PermissionDenied</h2> + User does not have the permission to activate this connection. + + +<h1>Errors:</h1> + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.General" id="org.freedesktop.NetworkManager.VPN.Error.General"></a>org.freedesktop.NetworkManager.VPN.Error.General</h2>This is a drab, nondescript error. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</h2>The request could not be processed because the VPN connection is already being started. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</h2>The request could not be processed because a VPN connection was already active. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</h2>The request could not be processed because the VPN connection is already being stopped. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</h2>The request could not be processed because the VPN connection was already stopped. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.WrongState" id="org.freedesktop.NetworkManager.VPN.Error.WrongState"></a>org.freedesktop.NetworkManager.VPN.Error.WrongState</h2>The request could not be processed because the VPN connection is in the wrong state for this type of request. FIXME: too general? + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.BadArguments" id="org.freedesktop.NetworkManager.VPN.Error.BadArguments"></a>org.freedesktop.NetworkManager.VPN.Error.BadArguments</h2>Invalid arguments were passed with the request. FIXME: too general. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed" id="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"></a>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</h2>A binary providing the service failed to launch. + <h2><a name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid" id="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"></a>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</h2>The request could not be processed because the VPN connection settings were invalid. +<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></code> + - u</li><li><code><a href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></code> + - u</li><li><code><a href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></code> + - u</li><li><code><a href="#type-NM_802_11_MODE">NM_802_11_MODE</a></code> + - u</li><li><code><a href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></code> + - u</li><li><code><a href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></code> + - u</li><li><code><a href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></code> + - u</li><li><code><a href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a></code> + - u</li><li><code><a href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></code> + - u</li><li><code><a href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></code> + - u</li><li><code><a href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></code> + - u</li><li><code><a href="#type-NM_STATE">NM_STATE</a></code> + - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code> + - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></code> + - u</li><li><code><a href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></code> + - u</li><li><code><a href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></code> + - u</li><li><code><a href="#type-String_String_Map">String_String_Map</a></code> + - a{ s → s } + </li><li><code><a href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a></code> + - a{ s → a{sv} } + </li><li><code><a href="#type-String_Variant_Map">String_Variant_Map</a></code> + - a{ s → v } + </li></ul></body></html> diff --git a/docs/api/html/style.css b/docs/api/html/style.css new file mode 100644 index 000000000..d6f6c26ec --- /dev/null +++ b/docs/api/html/style.css @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/api/html/up.png b/docs/api/html/up.png Binary files differnew file mode 100644 index 000000000..85b3e2a27 --- /dev/null +++ b/docs/api/html/up.png |
