pax_global_header00006660000000000000000000000064144212406470014516gustar00rootroot0000000000000052 comment=21fd2940e68e5990f655c8531c7ebbbfb4769cc6 python-sdbus-networkmanager-2.0rc2/000077500000000000000000000000001442124064700174475ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/.gitignore000066400000000000000000000016321442124064700214410ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of py_sd_bus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .mypy_cache .vscode *.pyc __pycache__ build dev* strace*.txt *.so .cache wheels python-sdbus-networkmanager-2.0rc2/.readthedocs.yml000066400000000000000000000001241442124064700225320ustar00rootroot00000000000000version: 2 python: version: 3.8 install: - requirements: requirements.txt python-sdbus-networkmanager-2.0rc2/COPYING000066400000000000000000000432541442124064700205120ustar00rootroot00000000000000 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 Lesser 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. Copyright (C) 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. , 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 Lesser General Public License instead of this License. python-sdbus-networkmanager-2.0rc2/COPYING.LESSER000066400000000000000000000636421442124064700215110ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 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. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, 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 and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, 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 library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete 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 distribute a copy of this License along with the Library. 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 Library or any portion of it, thus forming a work based on the Library, 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) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, 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 Library, 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 Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you 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. If distribution of 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 satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be 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. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library 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. 9. 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 Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library 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 with this License. 11. 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 Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library 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 Library. 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. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library 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. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser 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 Library 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 Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, 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 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. 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 LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), 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 Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. 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. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! python-sdbus-networkmanager-2.0rc2/README.md000066400000000000000000000015741442124064700207350ustar00rootroot00000000000000[![Documentation Status](https://readthedocs.org/projects/python-sdbus-networkmanager/badge/?version=latest)](https://python-sdbus-networkmanager.readthedocs.io/en/latest/?badge=latest) # NetworkManager binds for python-sdbus Supports both asyncio (under `sdbus_async.networkmanager` module) and blocking (under `sdbus_block.networkmanager` module) Implements most NetworkManager dbus interfaces and objects. ## Requirements * `python-sdbus` version higher than 0.8rc2 See [python-sdbus requirements](https://github.com/igo95862/python-sdbus#requirements). ## Installation `pip install --only-binary ':all:' sdbus-networkmanager` # [Documentation](https://python-sdbus-networkmanager.readthedocs.io/en/latest/) This is the sub-project of [python-sdbus](https://github.com/igo95862/python-sdbus). See the [python-sdbus documentation](https://python-sdbus.readthedocs.io/en/latest/). python-sdbus-networkmanager-2.0rc2/docs/000077500000000000000000000000001442124064700203775ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/docs/conf.py000066400000000000000000000021601442124064700216750ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from os.path import abspath from sys import path project = 'python-sdbus-networkmanager' author = 'igo95862' source_suffix = '.rst' extensions = ['sdbus.autodoc'] autoclass_content = 'both' autodoc_typehints = 'description' autodoc_member_order = 'bysource' path.insert(0, abspath('..')) python-sdbus-networkmanager-2.0rc2/docs/device_interfaces.rst000066400000000000000000000047371442124064700246060ustar00rootroot00000000000000Devices interfaces ================== Contains interfaces for most types of devices. .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceBluetoothInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceBondInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceBridgeInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceGenericInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceIPTunnelInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceLowpanInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceMacsecInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceMacvlanInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceModemInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceOlpcMeshInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceOvsBridgeInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceOvsPortInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceStatisticsInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceTeamInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceTunInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceVethInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceVlanInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceVrfInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceVxlanInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceWifiP2PInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceWiredInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceWireGuardInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceWirelessInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerPPPInterfaceAsync :members: python-sdbus-networkmanager-2.0rc2/docs/enums.rst000066400000000000000000000035731442124064700222700ustar00rootroot00000000000000Enums ================ .. autoclass:: sdbus_async.networkmanager.AccessPointCapabilities :members: .. autoclass:: sdbus_async.networkmanager.WpaSecurityFlags :members: .. autoclass:: sdbus_async.networkmanager.WiFiOperationMode :members: .. autoclass:: sdbus_async.networkmanager.SecretAgentCapabilities :members: .. autoclass:: sdbus_async.networkmanager.ConnectionState :members: .. autoclass:: sdbus_async.networkmanager.ConnectionStateFlags :members: .. autoclass:: sdbus_async.networkmanager.ConnectionStateReason :members: .. autoclass:: sdbus_async.networkmanager.BluetoothCapabilities :members: .. autoclass:: sdbus_async.networkmanager.IpTunnelMode :members: .. autoclass:: sdbus_async.networkmanager.ModemCapabilities :members: .. autoclass:: sdbus_async.networkmanager.WirelessCapabilities :members: .. autoclass:: sdbus_async.networkmanager.DeviceCapabilities :members: .. autoclass:: sdbus_async.networkmanager.DeviceState :members: .. autoclass:: sdbus_async.networkmanager.DeviceStateReason :members: .. autoclass:: sdbus_async.networkmanager.DeviceType :members: .. autoclass:: sdbus_async.networkmanager.DeviceMetered :members: .. autoclass:: sdbus_async.networkmanager.ConnectivityState :members: .. autoclass:: sdbus_async.networkmanager.DeviceInterfaceFlags :members: .. autoclass:: sdbus_async.networkmanager.ConnectionFlags :members: .. autoclass:: sdbus_async.networkmanager.VpnState :members: .. autoclass:: sdbus_async.networkmanager.VpnFailure :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerConnectivityState :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerState :members: Helper classes ----------------------- .. py:data:: DEVICE_TYPE_TO_CLASS :type: Dict[int, class] Mapping of NetworkManager device type int to the class. python-sdbus-networkmanager-2.0rc2/docs/examples.rst000066400000000000000000000041561442124064700227550ustar00rootroot00000000000000Examples ================== Listing interfaces ------------------ List interface and their IPv4 adress using blocking API: .. code-block:: python from sdbus_block.networkmanager import ( NetworkManager, NetworkDeviceGeneric, IPv4Config, ) from sdbus import sd_bus_open_system system_bus = sd_bus_open_system() # We need system bus nm = NetworkManager(system_bus) devices_paths = nm.get_devices() for device_path in devices_paths: generic_device = NetworkDeviceGeneric(device_path, system_bus) print('Device: ', generic_device.interface) device_ip4_conf_path = generic_device.ip4_config if device_ip4_conf_path == '/': # This is how NetworkManager indicates there is no ip config # for the interface continue else: ip4_conf = IPv4Config(device_ip4_conf_path, system_bus) for address_data in ip4_conf.address_data: print(' Ip Adress:', address_data['address'][1]) Same but using async API: .. code-block:: python from sdbus_async.networkmanager import ( NetworkManager, NetworkDeviceGeneric, IPv4Config, ) from sdbus import sd_bus_open_system from asyncio import run as async_run system_bus = sd_bus_open_system() # We need system bus nm = NetworkManager(system_bus) async def test() -> None: devices_paths = await nm.get_devices() for device_path in devices_paths: generic_device = NetworkDeviceGeneric(device_path, system_bus) print('Device: ', await generic_device.interface) device_ip4_conf_path = await generic_device.ip4_config if device_ip4_conf_path == '/': # This is how NetworkManager indicates there is no ip config # for the interface continue else: ip4_conf = IPv4Config(device_ip4_conf_path, system_bus) for address_data in await ip4_conf.address_data: print(' Ip Adress:', address_data['address'][1]) async_run(test()) python-sdbus-networkmanager-2.0rc2/docs/exceptions.rst000066400000000000000000000126571442124064700233250ustar00rootroot00000000000000NetworkManager errors and exceptions ==================================== .. autoexception:: sdbus_async.networkmanager.NetworkManagerBaseError Agent Manager errors -------------------- .. autoexception:: sdbus_async.networkmanager.NmAgentManagerFailedError .. autoexception:: sdbus_async.networkmanager.NmAgentManagerPermissionDeniedError .. autoexception:: sdbus_async.networkmanager.NmAgentManagerInvalidIdentifierError .. autoexception:: sdbus_async.networkmanager.NmAgentManagerNotRegisteredError .. autoexception:: sdbus_async.networkmanager.NmAgentManagerNoSecretsError .. autoexception:: sdbus_async.networkmanager.NmAgentManagerUserCanceledError Connection errors ----------------- .. autoexception:: sdbus_async.networkmanager.NmConnectionFailedError .. autoexception:: sdbus_async.networkmanager.NmConnectionSettingNotFoundError .. autoexception:: sdbus_async.networkmanager.NmConnectionPropertyNotFoundError .. autoexception:: sdbus_async.networkmanager.NmConnectionPropertyNotSecretError .. autoexception:: sdbus_async.networkmanager.NmConnectionMissingSettingError .. autoexception:: sdbus_async.networkmanager.NmConnectionInvalidSettingError .. autoexception:: sdbus_async.networkmanager.NmConnectionMissingPropertyError .. autoexception:: sdbus_async.networkmanager.NmConnectionInvalidPropertyError Device errors ------------- .. autoexception:: sdbus_async.networkmanager.NmDeviceFailedError .. autoexception:: sdbus_async.networkmanager.NmDeviceCreationFailedError .. autoexception:: sdbus_async.networkmanager.NmDeviceInvalidConnectionError .. autoexception:: sdbus_async.networkmanager.NmDeviceIncompatibleConnectionError .. autoexception:: sdbus_async.networkmanager.NmDeviceNotActiveError .. autoexception:: sdbus_async.networkmanager.NmDeviceNotSoftwareError .. autoexception:: sdbus_async.networkmanager.NmDeviceNotAllowedError .. autoexception:: sdbus_async.networkmanager.NmDeviceSpecificObjectNotFoundError .. autoexception:: sdbus_async.networkmanager.NmDeviceVersionIdMismatchError .. autoexception:: sdbus_async.networkmanager.NmDeviceMissingDependenciesError .. autoexception:: sdbus_async.networkmanager.NmDeviceInvalidArgumentError NetworkManager main errors -------------------------- Errors raised by main NetworkManager objects. .. autoexception:: sdbus_async.networkmanager.NetworkManagerFailedError .. autoexception:: sdbus_async.networkmanager.NetworkManagerPermissionDeniedError .. autoexception:: sdbus_async.networkmanager.NetworkManagerUnknownConnectionError .. autoexception:: sdbus_async.networkmanager.NetworkManagerUnknownDeviceError .. autoexception:: sdbus_async.networkmanager.NetworkManagerConnectionNotAvailableError .. autoexception:: sdbus_async.networkmanager.NetworkManagerConnectionNotActiveError .. autoexception:: sdbus_async.networkmanager.NetworkManagerConnectionAlreadyActiveError .. autoexception:: sdbus_async.networkmanager.NetworkManagerDependencyFailedError .. autoexception:: sdbus_async.networkmanager.NetworkManagerAlreadyAsleepOrAwakeError .. autoexception:: sdbus_async.networkmanager.NetworkManagerAlreadyEnabledOrDisabledError .. autoexception:: sdbus_async.networkmanager.NetworkManagerUnknownLogLevelError .. autoexception:: sdbus_async.networkmanager.NetworkManagerUnknownLogDomainError .. autoexception:: sdbus_async.networkmanager.NetworkManagerInvalidArgumentsError .. autoexception:: sdbus_async.networkmanager.NetworkManagerMissingPluginError Secret Manager errors --------------------- Errors that secret managers pass to NetworkManager. .. autoexception:: sdbus_async.networkmanager.NmSecretManagerFailedError .. autoexception:: sdbus_async.networkmanager.NmSecretManagerPermissionDeniedError .. autoexception:: sdbus_async.networkmanager.NmSecretManagerInvalidConnectionError .. autoexception:: sdbus_async.networkmanager.NmSecretManagerUserCanceledError .. autoexception:: sdbus_async.networkmanager.NmSecretManagerAgentCanceledError .. autoexception:: sdbus_async.networkmanager.NmSecretManagerNoSecretsError NetworkManager settings errors ------------------------------ .. autoexception:: sdbus_async.networkmanager.NmSettingsFailedError .. autoexception:: sdbus_async.networkmanager.NmSettingsPermissionDeniedError .. autoexception:: sdbus_async.networkmanager.NmSettingsNotSupportedError .. autoexception:: sdbus_async.networkmanager.NmSettingsInvalidConnectionError .. autoexception:: sdbus_async.networkmanager.NmSettingsReadOnlyConnectionError .. autoexception:: sdbus_async.networkmanager.NmSettingsUuidExistsError .. autoexception:: sdbus_async.networkmanager.NmSettingsInvalidHostnameError .. autoexception:: sdbus_async.networkmanager.NmSettingsInvalidArgumentsError VPN plugins errors ------------------ .. autoexception:: sdbus_async.networkmanager.NmVpnPluginFailedError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginStartingInProgressError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginAlreadyStartedError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginStoppingInProgressError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginAlreadyStoppedError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginWrongStateError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginBadArgumentsError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginLaunchFailedError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginInvalidConnectionError .. autoexception:: sdbus_async.networkmanager.NmVpnPluginInteractiveNotSupportedError python-sdbus-networkmanager-2.0rc2/docs/index.rst000066400000000000000000000012231442124064700222360ustar00rootroot00000000000000Network Manager binds for python-sdbus ====================================== This package contains python-sdbus for D-Bus interface of `NetworkManager `_. .. note:: See `upstream documentation for NetworkManager D-Bus API `_ for more detailed documentation. .. toctree:: :maxdepth: 3 :caption: Contents: objects examples device_interfaces other_interfaces profile_settings enums exceptions See `python-sdbus `_ homepage if you are unfamiliar with python-sdbus. python-sdbus-networkmanager-2.0rc2/docs/objects.rst000066400000000000000000000062351442124064700225700ustar00rootroot00000000000000Network Manager objects ======================= All objects avaiable in NetworkManager. Only the implemented interfaces for each object are documented. Click on interface link to see which properties and methods does the interface implements. Network Manager main object --------------------------- .. autoclass:: sdbus_async.networkmanager.NetworkManager :members: Network Manager settings ------------------------ .. autoclass:: sdbus_async.networkmanager.NetworkManagerSettings :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDnsManager :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerAgentManager :members: .. autoclass:: sdbus_async.networkmanager.NetworkConnectionSettings :members: Device objects -------------- .. autoclass:: sdbus_async.networkmanager.NetworkDeviceGeneric :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceWired :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceWireless :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceBluetooth :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceBond :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceBridge :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceIpTunnel :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceMacsec :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceMacvlan :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceModem :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceOlpcMesh :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceOpenVSwitchBridge :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceOpenVSwitchPort :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceTeam :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceTun :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceVeth :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceVlan :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceVrf :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceVxlan :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceWifiP2P :members: .. autoclass:: sdbus_async.networkmanager.NetworkDeviceWireGuard :members: .. autoclass:: sdbus_async.networkmanager.NetworkDevicePPP :members: Connection configuration objects -------------------------------- .. autoclass:: sdbus_async.networkmanager.ActiveConnection :members: .. autoclass:: sdbus_async.networkmanager.ActiveVPNConnection :members: .. autoclass:: sdbus_async.networkmanager.IPv4Config :members: .. autoclass:: sdbus_async.networkmanager.IPv6Config :members: .. autoclass:: sdbus_async.networkmanager.DHCPv4Config :members: .. autoclass:: sdbus_async.networkmanager.DHCPv6Config :members: Other objects ------------- .. autoclass:: sdbus_async.networkmanager.AccessPoint :members: .. autoclass:: sdbus_async.networkmanager.WiFiP2PPeer :members: .. autoclass:: sdbus_async.networkmanager.ConfigCheckpoint :members: python-sdbus-networkmanager-2.0rc2/docs/other_interfaces.rst000066400000000000000000000030221442124064700244520ustar00rootroot00000000000000Other interfaces ============================ Non-device interfaces implemented by NetworkManager. .. autoclass:: sdbus_async.networkmanager.NetworkManagerInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerWifiP2PPeerInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerVPNPluginInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerSettingsInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerSettingsConnectionInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerSecretAgentInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerIP6ConfigInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerIP4ConfigInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDnsManagerInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDHCP6ConfigInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerDHCP4ConfigInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerVPNConnectionInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerConnectionActiveInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerCheckpointInterfaceAsync :members: .. autoclass:: sdbus_async.networkmanager.NetworkManagerSecretAgentManagerInterfaceAsync :members: python-sdbus-networkmanager-2.0rc2/docs/profile_settings.rst000066400000000000000000000103161442124064700245120ustar00rootroot00000000000000Connection Profile Settings Helpers =================================== .. autoclass:: sdbus_async.networkmanager.settings.AdslSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.BluetoothSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.BondSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.BondPortSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.BridgeSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.BridgePortSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.CdmaSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.ConnectionSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.DcbSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.DummySettings :members: .. autoclass:: sdbus_async.networkmanager.settings.EapolSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.EthernetSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.EthtoolSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.GenericSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.GsmSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.HostnameSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.InfinibandSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.IpTunnelSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.Ipv4Settings :members: .. autoclass:: sdbus_async.networkmanager.settings.Ipv6Settings :members: .. autoclass:: sdbus_async.networkmanager.settings.LowpanSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.MacsecSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.MacvlanSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.MatchSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OlpcMeshSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsBridgeSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsDpdkSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsExternalIdsSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsInterfaceSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsPatchSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.OvsPortSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.PppSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.PppoeSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.ProxySettings :members: .. autoclass:: sdbus_async.networkmanager.settings.SerialSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.SriovSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.TcSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.TeamSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.TeamPortSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.TunSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.UserSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.VethSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.VlanSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.VpnSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.VrfSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.VxlanSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WifiP2PSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WimaxSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WireguardSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WirelessSettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WirelessSecuritySettings :members: .. autoclass:: sdbus_async.networkmanager.settings.WpanSettings :members: python-sdbus-networkmanager-2.0rc2/examples/000077500000000000000000000000001442124064700212655ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/examples/async/000077500000000000000000000000001442124064700224025ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/examples/async/add-eth-connection-async.py000077500000000000000000000105071442124064700275400ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to create a new Ethernet network connection profile: # # examples/block/add-eth-connection-async.py --help # usage: add-eth-connection-async.py [-h] [-c CONN_ID] [-u UUID] [-4 IP4] # [-i INTERFACE_NAME] [-g GW] [-a] [--save] # # Optional arguments have example values: # # optional arguments: # -h, --help show this help message and exit # -c CONN_ID Connection Id # -u UUID Connection UUID # -i INTERFACE_NAME ethX device # -4 IP4 IP4/prefix # -g GW gw/metric # -a autoconnect # --save Save # # Connection Profile settings are described at: # https://networkmanager.dev/docs/api/latest/ref-settings.html import asyncio import sdbus import functools import logging import pprint import sys from uuid import uuid4 from argparse import ArgumentParser, Namespace from sdbus_async.networkmanager import NetworkManagerSettings from sdbus_async.networkmanager import NetworkManagerConnectionProperties async def add_ethernet_connection_async(args: Namespace) -> str: """Add a (by default) temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ info = logging.getLogger().info # If we add many connections using the same id, things get messy. Check: if await NetworkManagerSettings().get_connections_by_id(args.conn_id): info(f'Connections using ID "{args.conn_id}" exist, remove them:') info(f'Run: nmcli connection delete "{args.conn_id}"') return "" ipaddr, prefix = args.ip4.split("/") properties: NetworkManagerConnectionProperties = { "connection": { "id": ("s", args.conn_id), "uuid": ("s", str(args.uuid)), "type": ("s", "802-3-ethernet"), "autoconnect": ("b", args.auto), }, "ipv4": { "method": ("s", "manual"), "address-data": ( "aa{sv}", [ { "address": ("s", ipaddr), "prefix": ("u", int(prefix)), }, ], ), }, "ipv6": {"method": ("s", "disabled")}, } if args.interface_name: properties["connection"]["interface-name"] = ("s", args.interface_name) if len(sys.argv) == 1 or args.gw != "192.0.2.1/4000": default_gateway, route_metric = args.gw.split("/") properties["ipv4"]["gateway"] = ("s", default_gateway) properties["ipv4"]["route-metric"] = ("u", int(route_metric)) s = NetworkManagerSettings() addconnection = s.add_connection if args.save else s.add_connection_unsaved connection_settings_dbus_path = await addconnection(properties) created = "created and saved" if args.save else "created" info(f"New unsaved connection profile {created}, show it with:") info(f'nmcli connection show "{args.conn_id}"|grep -v -e -- -e default') info("Settings used:") info(functools.partial(pprint.pformat, sort_dicts=False)(properties)) return connection_settings_dbus_path if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.INFO) p = ArgumentParser(description="Optional arguments have example values:") conn_id = "MyConnectionExample" p.add_argument("-c", dest="conn_id", default=conn_id, help="Connection Id") p.add_argument("-u", dest="uuid", default=uuid4(), help="Connection UUID") p.add_argument("-i", dest="interface_name", default="", help="ethX device") p.add_argument("-4", dest="ip4", default="192.0.2.8/24", help="IP4/prefix") p.add_argument("-g", dest="gw", default="192.0.2.1/4000", help="gw/metric") p.add_argument("-a", dest="auto", action="store_true", help="autoconnect") p.add_argument("--save", dest="save", action="store_true", help="Save") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) if connection_dpath := asyncio.run(add_ethernet_connection_async(args)): print(f"Path of the new connection: {connection_dpath}") print(f"UUID of the new connection: {args.uuid}") else: print("Error: No new connection created.") python-sdbus-networkmanager-2.0rc2/examples/async/add-wifi-psk-connection-async.py000077500000000000000000000134061442124064700305120ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to create a new WiFi-PSK network connection profile: # # $ examples/async/add-wifi-psk-connection-async.py --help # usage: add-wifi-psk-connection.py [-h] [-c CONN_ID] [-s SSID] [-p PSK] # [-i INTERFACE_NAME] [-a] [--save] # # Optional arguments have example values: # # optional arguments: # -h, --help show this help message and exit # -c CONN_ID Connection Id # -u UUID Connection UUID # -s SSID WiFi SSID # -p PSK WiFi PSK # -i INTERFACE_NAME WiFi device # -a autoconnect # --save Save # # $ add-wifi-psk-connection.py # New unsaved connection profile created, show it with: # nmcli connection show "MyConnectionExample"|grep -v -e -- -e default # Settings used: # {'connection': {'id': ('s', 'MyConnectionExample'), # 'uuid': ('s', '90e3bcc8-d3a5-4725-a363-abb788fd47bf'), # 'type': ('s', '802-11-wireless'), # 'autoconnect': ('b', False)}, # '802-11-wireless': {'mode': ('s', 'infrastructure'), # 'security': ('s', '802-11-wireless-security'), # 'ssid': ('ay', b'CafeSSID')}, # '802-11-wireless-security': {'key-mgmt': ('s', 'wpa-psk'), # 'auth-alg': ('s', 'open'), # 'psk': ('s', 'Coffee!!')}, # 'ipv4': {'method': ('s', 'auto')}, # 'ipv6': {'method': ('s', 'auto')}} # # Connection Profile settings are described at: # https://networkmanager.dev/docs/api/latest/ref-settings.html # # Note: By default, it uses add_connection_unsaved() to add a temporary # memory-only connection which is not saved to the system-connections folder: # For reference, see: https://networkmanager.dev/docs/api/latest/spec.html # -> org.freedesktop.NetworkManager.Settings (Settings Profile Manager) import asyncio import binascii import functools import logging import sdbus from uuid import uuid4 from argparse import ArgumentParser, Namespace from passlib.utils.pbkdf2 import pbkdf2 # type: ignore from pprint import pformat from sdbus_async.networkmanager import ( NetworkManagerSettings as SettingsManager, ConnectionType, ) from sdbus_async.networkmanager.settings import ( ConnectionProfile, ConnectionSettings, Ipv4Settings, Ipv6Settings, WirelessSettings, WirelessSecuritySettings, ) async def add_wifi_psk_connection_async(args: Namespace) -> str: """Add a temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ info = logging.getLogger().info # If we add many connections passing the same id, things get messy. Check: if await SettingsManager().get_connections_by_id(args.conn_id): print(f'Connection "{args.conn_id}" exists, remove it first') print(f'Run: nmcli connection delete "{args.conn_id}"') return "" if args.key_mgmt == "wpa-psk" and len(args.password) < 64: # Hash the password into a psk hash to not store it in clear form: pw = pbkdf2(args.password.encode(), args.ssid.encode(), 4096, 32) args.password = binascii.hexlify(pw).decode("utf-8") profile = ConnectionProfile( connection=ConnectionSettings( connection_id=args.conn_id, uuid=str(args.uuid), connection_type=ConnectionType.WIFI.value, autoconnect=bool(hasattr(args, "auto") and args.auto), ), ipv4=Ipv4Settings(method="auto"), ipv6=Ipv6Settings(method="auto"), wireless=WirelessSettings(ssid=args.ssid.encode("utf-8")), wireless_security=WirelessSecuritySettings( key_mgmt=args.key_mgmt, auth_alg="open", psk=args.password ), ) # To bind the new connection to a specific interface, use this: if hasattr(args, "interface_name") and args.interface_name: profile.connection.interface_name = args.interface_name s = SettingsManager() save = bool(hasattr(args, "save") and args.save) addconnection = s.add_connection if save else s.add_connection_unsaved connection_settings_dbus_path = await addconnection(profile.to_dbus()) created = "created and saved" if save else "created" info(f"New unsaved connection profile {created}, show it with:") info(f'nmcli connection show "{args.conn_id}"|grep -v -e -- -e default') info("Settings used:") info(functools.partial(pformat, sort_dicts=False)(profile.to_settings_dict())) return connection_settings_dbus_path if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.INFO) p = ArgumentParser(description="Optional arguments have example values:") conn_id = "MyConnectionExample" p.add_argument("-c", dest="conn_id", default=conn_id, help="Connection Id") p.add_argument("-u", dest="uuid", default=uuid4(), help="Connection UUID") p.add_argument("-s", dest="ssid", default="CafeSSID", help="WiFi SSID") p.add_argument("-k", dest="key_mgmt", default="wpa-psk", help="key-mgmt") p.add_argument("-p", dest="password", default="Coffee!!", help="WiFi PSK") p.add_argument("-i", dest="interface_name", default="", help="WiFi device") p.add_argument("-a", dest="auto", action="store_true", help="autoconnect") p.add_argument("--save", dest="save", action="store_true", help="Save") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) if connection_dpath := asyncio.run(add_wifi_psk_connection_async(args)): print(f"Path of the new connection: {connection_dpath}") print(f"UUID of the new connection: {args.uuid}") else: print("Error: No new connection created.") python-sdbus-networkmanager-2.0rc2/examples/async/delete-connection-by-uuid-async.py000077500000000000000000000031631442124064700310500ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Create and delete a connection profile using the unique connection uuid # import asyncio import logging import sdbus from uuid import uuid4 from argparse import Namespace from sdbus_async.networkmanager import NetworkManagerSettings from sdbus_async.networkmanager import NmSettingsInvalidConnectionError async def delete_connection_by_uuid(uuid: str) -> bool: """Find and delete the connection identified by the given UUID""" try: await NetworkManagerSettings().delete_connection_by_uuid(uuid) except NmSettingsInvalidConnectionError: logging.getLogger().fatal(f"Connection {uuid} for deletion not found") return False return True async def create_and_delete_wifi_psk_connection_async(args: Namespace) -> bool: """Add a temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ add_wifi_psk_connection = __import__("add-wifi-psk-connection-async") if not await add_wifi_psk_connection.add_wifi_psk_connection_async(args): return False return await delete_connection_by_uuid(str(args.uuid)) if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.WARNING) sdbus.set_default_bus(sdbus.sd_bus_open_system()) args = Namespace(conn_id="Example", uuid=uuid4(), ssid="S", psk="Password") if asyncio.run(create_and_delete_wifi_psk_connection_async(args)): print(f"Succeeded in creating and deleting connection {args.uuid}") python-sdbus-networkmanager-2.0rc2/examples/async/device-state-async.py000077500000000000000000000054331442124064700264540ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to list the network devices including type, state, internet # connectivitycheck state and the identifier of the active connection. # # NetworkDeviceGeneric/org.freedesktop.NetworkManager.Device is described at # https://networkmanager.dev/docs/api/latest/ref-dbus-devices.html # # The output resembles the output of the NM CLI command "nmcli device": # # Interface Type State Internet Connection # lo Generic Unmanaged Unknown # wlp0s20f3 Wifi Activated Full Wolke7 [primary connection] # docker0 Bridge Activated None docker0 # enx0c3796090408 Ethernet Activated Full enx0c3796090408 # p2p-dev-wlp0s20f3 Wifi_P2P Disconnected None import argparse import asyncio import sdbus from sdbus_async.networkmanager import ( NetworkManager, NetworkDeviceGeneric, DeviceState, DeviceType, DeviceCapabilities as Capabilities, ActiveConnection, ConnectivityState, ) from enum import Enum def title(enum: Enum) -> str: """Get the name of an enum: 1st character is uppercase, rest lowercase""" return enum.name.title() async def list_active_hardware_networkdevice_states(only_hw: bool) -> None: """Print the list of activated network devices similar to nmcli device""" nm = NetworkManager() devices_paths = await nm.get_devices() print("Interface Type State Internet Connection") for device_path in devices_paths: generic = NetworkDeviceGeneric(device_path) # Demonstrates an enum to match devices using capabilities: if only_hw and await generic.capabilities & Capabilities.IS_SOFTWARE: continue # Create the strings for the columns using the names of the enums: dev: str = await generic.interface dtype = title(DeviceType(await generic.device_type)) state = title(DeviceState(await generic.state)) connectivity = title(ConnectivityState(await generic.ip4_connectivity)) name: str = "" if await generic.active_connection != "/": # Connection is active # ActiveConnection() gets propertites from active connection path: active_conn = ActiveConnection(await generic.active_connection) name = await active_conn.id if await active_conn.default: name += " [primary connection]" print(f"{dev:<17} {dtype:<8} {state:<12} {connectivity:<8} {name:<14}") if __name__ == "__main__": p = argparse.ArgumentParser() p.add_argument("--hw", action="store_true", dest="only_hw", help="Only HW") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) asyncio.run(list_active_hardware_networkdevice_states(args.only_hw)) python-sdbus-networkmanager-2.0rc2/examples/async/list-connections-async.py000077500000000000000000000044221442124064700273670ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example which lists the details of NetworkManager's connection profiles. # This is the asyncio variant of this example using sdbus_async.networkmanager. # The blocking variant of this example is examples/block/list-connections.py # # Configuration settings are described at # https://networkmanager.dev/docs/api/latest/ref-settings.html # # Example output: # | name: Wired connection 1 # | uuid: b2caabdc-98bb-3f88-8d28-d10369d6ded9 # | type: 802-3-ethernet # | interface-name: enx001e101f0000 # | ipv4: method: manual # | ipaddr: 192.168.178.34/24 # | route-metric: 200 # | ipv6: method: disabled import asyncio import sdbus import pprint from sdbus_async.networkmanager import ( NetworkManagerSettings, NetworkConnectionSettings, ) from typing import List async def list_connection_profiles_async() -> None: networkmanager_settings = NetworkManagerSettings() connections_paths: List[str] = await networkmanager_settings.connections for dbus_connection_path in connections_paths: await print_connection_profile(dbus_connection_path) async def print_connection_profile(connection_path: str) -> None: connectionsettings_service = NetworkConnectionSettings(connection_path) profile = await connectionsettings_service.connection_profile() connection = profile.connection print("-------------------------------------------------------------") print("name:", connection.connection_id) print("uuid:", connection.uuid) print("type:", connection.connection_type) if connection.interface_name: print(" interface-name:", connection.interface_name) if profile.ipv4: print("ipv4: method:", profile.ipv4.method) if profile.ipv4.address_data: for address in profile.ipv4.address_data: print(f' ipaddr: {address.address}/{address.prefix}') if profile.ipv4.route_metric: print(f' route-metric: {profile.ipv4.route_metric}') if profile.ipv6: print("ipv6: method:", profile.ipv6.method) pprint.pprint(profile.to_settings_dict(), sort_dicts=False) if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) asyncio.run(list_connection_profiles_async()) python-sdbus-networkmanager-2.0rc2/examples/async/netdevinfo-async.py000077500000000000000000000106571442124064700262440ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to list the active IPv4 protocol configuration of network devices # and the current status of WiFi adapters # # For IPv4 and org.freedesktop.NetworkManager.Device.Wireless see: # https://networkmanager.dev/docs/api/latest/settings-ipv4.html # https://networkmanager.dev/docs/api/latest/ref-dbus-devices.html import asyncio import sdbus from sdbus_async.networkmanager import ( ConnectionType, NetworkConnectionSettings, NetworkManager, NetworkManagerSettings, NetworkDeviceGeneric, IPv4Config, DeviceType, NetworkDeviceWireless, WiFiOperationMode, AccessPoint, ) from typing import Any, Dict, List, Optional, Tuple NetworkManagerAddressData = List[Dict[str, Tuple[str, Any]]] async def get_most_recent_connection_id(ifname: str, dev_type: str) -> Optional[str]: """Return the most-recently used connection_id for this device Besides getting the currently active connection, this will succeed in getting the most recent connection when a device is not connected at the moment this function is executed. It uses getattr(ConnectionType, dev_type) to get the connection_type used for connection_profiles for this DeviceType. With a slight modification, this could return the most recent connections of the given device, ordered by the time of the last use of them. """ settings_service = NetworkManagerSettings() connection_paths: List[str] = await settings_service.connections conns = {} for connection_path in connection_paths: connection_manager = NetworkConnectionSettings(connection_path) connection = (await connection_manager.connection_profile()).connection # Filter connection profiles matching the connection type for the device: if connection.connection_type != getattr(ConnectionType, dev_type): continue # If the interface_name of a connection profiles is set, it must match: if connection.interface_name and connection.interface_name != ifname: continue # If connection.timestamp is not set, it was never active. Set it to 0: if not connection.timestamp: connection.timestamp = 0 # Record the connection_ids of the matches, and timestamp is the key: conns[connection.timestamp] = connection.connection_id if not len(conns): return None # Returns the connection_id of the highest timestamp which was found: return conns.get(max(conns.keys())) async def list_networkdevice_details_async() -> None: nm = NetworkManager() devices_paths = await nm.get_devices() for device_path in devices_paths: generic_device = NetworkDeviceGeneric(device_path) device_ip4_conf_path: str = await generic_device.ip4_config if device_ip4_conf_path == "/": continue if not await generic_device.managed: continue dev_type = DeviceType(await generic_device.device_type).name if dev_type == DeviceType.BRIDGE.name: continue dev_name = await generic_device.interface ip4_conf = IPv4Config(device_ip4_conf_path) gateway: str = await ip4_conf.gateway print("Type: ", dev_type.title()) print("Name: ", dev_name) if gateway: print("Gateway:", gateway) address_data: NetworkManagerAddressData = await ip4_conf.address_data for inetaddr in address_data: print(f'Address: {inetaddr["address"][1]}/{inetaddr["prefix"][1]}') nameservers: NetworkManagerAddressData = await ip4_conf.nameserver_data for dns in nameservers: print("DNS: ", dns["address"][1]) if dev_type == DeviceType.WIFI.name: wifi = NetworkDeviceWireless(device_path) print("Wifi: ", WiFiOperationMode(await wifi.mode).name.title()) ap = AccessPoint(await wifi.active_access_point) ssid: bytes = await ap.ssid if ssid: print("SSID: ", ssid.decode("utf-8", "ignore")) if await ap.strength: print("Signal: ", await ap.strength) connection_id = await get_most_recent_connection_id(dev_name, dev_type) if connection_id: print("Profile:", connection_id) print("") if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) asyncio.run(list_networkdevice_details_async()) python-sdbus-networkmanager-2.0rc2/examples/async/update-connection-async.py000077500000000000000000000053211442124064700275120ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Update a property of a connection profile, looked up by connection id # # This version uses connection_manager.connection_profile().to_settings_dict() # to retrieve the connection profile from NetworkManager as a settings dict. # # It then updates it dynamically using the given arguments: # The default is to set ipv4.dns-search to ["domain1.com", "domain2.com"]. # # The dynamically updated dict is then used to update connection profile of NM. # # The IPv4 settings of connections profiles are documented here: # https://networkmanager.dev/docs/api/latest/settings-ipv4.html # import asyncio import sdbus from functools import partial from sdbus_async.networkmanager import NetworkManagerSettings from sdbus_async.networkmanager import NetworkConnectionSettings from sdbus_async.networkmanager.settings import ConnectionProfile from pprint import pprint from typing import Any, Dict async def update_connection_async(args: Dict[str, Any]) -> None: """Update the settings for [key][entry] of the 1st matching connection""" # Get the connection path of the connection(s) with the recieved id fn = NetworkManagerSettings().get_connections_by_id(args["connection_id"]) connection_paths = await fn if not connection_paths: print(f"No connection {id}, create with add-wifi-psk-connection-async") return # Get the profile settings of the first connecttion with given id connection_manager = NetworkConnectionSettings(connection_paths[0]) existing_connection_profile = await connection_manager.connection_profile() settings = existing_connection_profile.to_settings_dict() # Update the given setting's property using the given value setting, property = args["connection_setting"] settings[setting][property] = args["value"] # Get a new ConnectionProfile with the change incorporated new_connection_profile = ConnectionProfile.from_settings_dict(settings) # Update the new ConnectionProfile in NetworkManager's configuration await connection_manager.update(new_connection_profile.to_dbus()) print(f'Updated {new_connection_profile.connection.uuid}.{setting}:') partial(pprint, sort_dicts=False)(settings) # Restore the previous connection profile: await connection_manager.update(existing_connection_profile.to_dbus()) if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) args = { # Set MyConnectionExample.ipv4.dns-search to "domain1.com,domain2.com": "connection_id": "MyConnectionExample", "connection_setting": ("ipv4", "dns-search"), "value": ["domain1.com", "domain2.com"], } asyncio.run(update_connection_async(args)) python-sdbus-networkmanager-2.0rc2/examples/block/000077500000000000000000000000001442124064700223575ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/examples/block/add-eth-connection.py000077500000000000000000000103731442124064700264030ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to create a new Ethernet network connection profile: # # examples/block/add-eth-connection.py --help # usage: add-eth-connection.py [-h] [-c CONN_ID] [-u UUID] [-i INTERFACE_NAME] # [-4 IP4] [-g GW] [-a] [--save] # # Optional arguments have example values: # # optional arguments: # -h, --help show this help message and exit # -c CONN_ID Connection Id # -u UUID Connection UUID # -i INTERFACE_NAME ethX device # -4 IP4 IP4/prefix # -g GW gw/metric # -a autoconnect # --save Save # # Connection Profile settings are described at: # https://networkmanager.dev/docs/api/latest/ref-settings.html import sdbus import functools import logging import pprint import sys from uuid import uuid4 from argparse import ArgumentParser, Namespace from sdbus_block.networkmanager import NetworkManagerSettings from sdbus_block.networkmanager import NetworkManagerConnectionProperties def add_ethernet_connection(args: Namespace) -> str: """Add a (by default) temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ info = logging.getLogger().info # If we add many connections using the same id, things get messy. Check: if NetworkManagerSettings().get_connections_by_id(args.conn_id): info(f'Connections using ID "{args.conn_id}" exist, remove them:') info(f'Run: nmcli connection delete "{args.conn_id}"') return "" ipaddr, prefix = args.ip4.split("/") properties: NetworkManagerConnectionProperties = { "connection": { "id": ("s", args.conn_id), "uuid": ("s", str(args.uuid)), "type": ("s", "802-3-ethernet"), "autoconnect": ("b", args.auto), }, "ipv4": { "method": ("s", "manual"), "address-data": ( "aa{sv}", [ { "address": ("s", ipaddr), "prefix": ("u", int(prefix)), }, ], ), }, "ipv6": {"method": ("s", "disabled")}, } if args.interface_name: properties["connection"]["interface-name"] = ("s", args.interface_name) if len(sys.argv) == 1 or args.gw != "192.0.2.1/4000": default_gateway, route_metric = args.gw.split("/") properties["ipv4"]["gateway"] = ("s", default_gateway) properties["ipv4"]["route-metric"] = ("u", int(route_metric)) s = NetworkManagerSettings() addconnection = s.add_connection if args.save else s.add_connection_unsaved connection_settings_dbus_path = addconnection(properties) created = "created and saved" if args.save else "created" info(f"New unsaved connection profile {created}, show it with:") info(f'nmcli connection show "{args.conn_id}"|grep -v -e -- -e default') info("Settings used:") info(functools.partial(pprint.pformat, sort_dicts=False)(properties)) return connection_settings_dbus_path if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.INFO) p = ArgumentParser(description="Optional arguments have example values:") conn_id = "MyConnectionExample" p.add_argument("-c", dest="conn_id", default=conn_id, help="Connection Id") p.add_argument("-u", dest="uuid", default=uuid4(), help="Connection UUID") p.add_argument("-i", dest="interface_name", default="", help="ethX device") p.add_argument("-4", dest="ip4", default="192.0.2.8/24", help="IP4/prefix") p.add_argument("-g", dest="gw", default="192.0.2.1/4000", help="gw/metric") p.add_argument("-a", dest="auto", action="store_true", help="autoconnect") p.add_argument("--save", dest="save", action="store_true", help="Save") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) if connection_dpath := add_ethernet_connection(args): print(f"Path of the new connection: {connection_dpath}") print(f"UUID of the new connection: {args.uuid}") else: print("Error: No new connection created.") python-sdbus-networkmanager-2.0rc2/examples/block/add-wifi-psk-connection.py000077500000000000000000000124601442124064700273530ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to create a new WiFi-PSK network connection profile: # # $ examples/block/add-wifi-psk-connection.py --help # usage: add-wifi-psk-connection.py [-h] [-c CONN_ID] [-s SSID] [-p PSK] # [-i INTERFACE_NAME] [-a] [--save] # # Optional arguments have example values: # # optional arguments: # -h, --help show this help message and exit # -c CONN_ID Connection Id # -u UUID Connection UUID # -s SSID WiFi SSID # -p PSK WiFi PSK # -i INTERFACE_NAME WiFi device # -a autoconnect # --save Save # # $ add-wifi-psk-connection.py # New unsaved connection profile created, show it with: # nmcli connection show "MyConnectionExample"|grep -v -e -- -e default # Settings used: # {'connection': {'id': ('s', 'MyConnectionExample'), # 'uuid': ('s', '90e3bcc8-d3a5-4725-a363-abb788fd47bf'), # 'type': ('s', '802-11-wireless'), # 'autoconnect': ('b', False)}, # '802-11-wireless': {'mode': ('s', 'infrastructure'), # 'security': ('s', '802-11-wireless-security'), # 'ssid': ('ay', b'CafeSSID')}, # '802-11-wireless-security': {'key-mgmt': ('s', 'wpa-psk'), # 'auth-alg': ('s', 'open'), # 'psk': ('s', 'Coffee!!')}, # 'ipv4': {'method': ('s', 'auto')}, # 'ipv6': {'method': ('s', 'auto')}} # # Connection Profile settings are described at: # https://networkmanager.dev/docs/api/latest/ref-settings.html # # Note: By default, it uses add_connection_unsaved() to add a temporary # memory-only connection which is not saved to the system-connections folder: # For reference, see: https://networkmanager.dev/docs/api/latest/spec.html # -> org.freedesktop.NetworkManager.Settings (Settings Profile Manager) import functools import logging import pprint import sdbus from uuid import uuid4 from argparse import ArgumentParser, Namespace from sdbus_block.networkmanager import NetworkManagerSettings from sdbus_block.networkmanager import NetworkManagerConnectionProperties def add_wifi_psk_connection(args: Namespace) -> str: """Add a temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ info = logging.getLogger().info # If we add many connections passing the same id, things get messy. Check: if NetworkManagerSettings().get_connections_by_id(args.conn_id): print(f'Connection "{args.conn_id}" exists, remove it first') print(f'Run: nmcli connection delete "{args.conn_id}"') return "" properties: NetworkManagerConnectionProperties = { "connection": { "id": ("s", args.conn_id), "uuid": ("s", str(args.uuid)), "type": ("s", "802-11-wireless"), "autoconnect": ("b", bool(hasattr(args, "auto") and args.auto)), }, "802-11-wireless": { "mode": ("s", "infrastructure"), "security": ("s", "802-11-wireless-security"), "ssid": ("ay", args.ssid.encode("utf-8")), }, "802-11-wireless-security": { "key-mgmt": ("s", "wpa-psk"), "auth-alg": ("s", "open"), "psk": ("s", args.psk), }, "ipv4": {"method": ("s", "auto")}, "ipv6": {"method": ("s", "auto")}, } # To bind the new connection to a specific interface, use this: if hasattr(args, "interface_name") and args.interface_name: properties["connection"]["interface-name"] = ("s", args.interface_name) s = NetworkManagerSettings() save = bool(hasattr(args, "save") and args.save) addconnection = s.add_connection if save else s.add_connection_unsaved connection_settings_dbus_path = addconnection(properties) created = "created and saved" if save else "created" info(f"New unsaved connection profile {created}, show it with:") info(f'nmcli connection show "{args.conn_id}"|grep -v -e -- -e default') info("Settings used:") info(functools.partial(pprint.pformat, sort_dicts=False)(properties)) return connection_settings_dbus_path if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.INFO) p = ArgumentParser(description="Optional arguments have example values:") conn_id = "MyConnectionExample" p.add_argument("-c", dest="conn_id", default=conn_id, help="Connection Id") p.add_argument("-u", dest="uuid", default=uuid4(), help="Connection UUID") p.add_argument("-s", dest="ssid", default="CafeSSID", help="WiFi SSID") p.add_argument("-p", dest="psk", default="Coffee!!", help="WiFi PSK") p.add_argument("-i", dest="interface_name", default="", help="WiFi device") p.add_argument("-a", dest="auto", action="store_true", help="autoconnect") p.add_argument("--save", dest="save", action="store_true", help="Save") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) if connection_dpath := add_wifi_psk_connection(args): print(f"Path of the new connection: {connection_dpath}") print(f"UUID of the new connection: {args.uuid}") else: print("Error: No new connection created.") python-sdbus-networkmanager-2.0rc2/examples/block/delete-connection-by-uuid.py000077500000000000000000000030551442124064700277120ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Create and delete a connection profile using the unique connection uuid # import logging import sdbus from uuid import uuid4 from argparse import Namespace from sdbus_block.networkmanager import NetworkManagerSettings from sdbus_block.networkmanager import NmSettingsInvalidConnectionError def delete_connection_by_uuid(uuid: str) -> bool: """Find and delete the connection identified by the given UUID""" try: NetworkManagerSettings().delete_connection_by_uuid(uuid) except NmSettingsInvalidConnectionError: logging.getLogger().fatal(f"Connection {uuid} for deletion not found") return False return True def create_and_delete_wifi_psk_connection_async(args: Namespace) -> bool: """Add a temporary (not yet saved) network connection profile :param Namespace args: autoconnect, conn_id, psk, save, ssid, uuid :return: dbus connection path of the created connection profile """ add_wifi_psk_connection = __import__("add-wifi-psk-connection") if not add_wifi_psk_connection.add_wifi_psk_connection(args): return False return delete_connection_by_uuid(str(args.uuid)) if __name__ == "__main__": logging.basicConfig(format="%(message)s", level=logging.WARNING) sdbus.set_default_bus(sdbus.sd_bus_open_system()) args = Namespace(conn_id="Example", uuid=uuid4(), ssid="S", psk="Password") if create_and_delete_wifi_psk_connection_async(args): print(f"Succeeded in creating and deleting connection {args.uuid}") python-sdbus-networkmanager-2.0rc2/examples/block/device-state.py000077500000000000000000000053551442124064700253210ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to list the network devices including type, state, internet # connectivitycheck state and the identifier of the active connection. # # NetworkDeviceGeneric/org.freedesktop.NetworkManager.Device is described at # https://networkmanager.dev/docs/api/latest/ref-dbus-devices.html # # The output resembles the output of the NM CLI command "nmcli device": # # Interface Type State Internet Connection # lo Generic Unmanaged Unknown # wlp0s20f3 Wifi Activated Full Wolke7 [primary connection] # docker0 Bridge Activated None docker0 # enx0c3796090408 Ethernet Activated Full enx0c3796090408 # p2p-dev-wlp0s20f3 Wifi_P2P Disconnected None import argparse import sdbus from sdbus_block.networkmanager import ( NetworkManager, NetworkDeviceGeneric, DeviceState, DeviceType, DeviceCapabilities as Capabilities, ActiveConnection, ConnectivityState, ) from enum import Enum def title(enum: Enum) -> str: """Get the name of an enum: 1st character is uppercase, rest lowercase""" return enum.name.title() def list_active_hardware_networkdevice_states(only_hw: bool) -> None: """Print the list of activated network devices similar to nmcli device""" nm = NetworkManager() devices_paths = nm.get_devices() print("Interface Type State Internet Connection") for device_path in devices_paths: generic_dev = NetworkDeviceGeneric(device_path) # Demonstrates an enum to match devices using capabilities: if only_hw and generic_dev.capabilities & Capabilities.IS_SOFTWARE: continue # Create the strings for the columns using the names of the enums: dev = generic_dev.interface type = title(DeviceType(generic_dev.device_type)) state = title(DeviceState(generic_dev.state)) connectivity = title(ConnectivityState(generic_dev.ip4_connectivity)) if generic_dev.active_connection == "/": # No active connection id = "" else: # ActiveConnection() gets propertites from active connection path: active_connection = ActiveConnection(generic_dev.active_connection) id = active_connection.id if active_connection.default: id += " [primary connection]" print(f"{dev:<17} {type:<8} {state:<12} {connectivity:<8} {id:<14}") if __name__ == "__main__": p = argparse.ArgumentParser() p.add_argument("--hw", action="store_true", dest="only_hw", help="Only HW") args = p.parse_args() sdbus.set_default_bus(sdbus.sd_bus_open_system()) list_active_hardware_networkdevice_states(args.only_hw) python-sdbus-networkmanager-2.0rc2/examples/block/list-connections.py000077500000000000000000000043601442124064700262320ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example which lists the details of NetworkManager's connection profiles. # # Configuration settings are described at # https://networkmanager.dev/docs/api/latest/ref-settings.html # # Example output: # | name: Wired connection 1 # | uuid: b2caabdc-98bb-3f88-8d28-d10369d6ded9 # | type: 802-3-ethernet # | interface-name: enx001e101f0000 # | ipv4: method: manual # | ipaddr: 192.168.178.34/24 # | route-metric: 200 # | ipv6: method: disabled import sdbus from sdbus_block.networkmanager import ( ConnectionType, NetworkManagerSettings, NetworkConnectionSettings, ) def list_connection_profiles_blocking() -> None: """Call print_connection_profile_blocking() for all connection profiles""" networkmanager_settings = NetworkManagerSettings() for dbus_connection_path in networkmanager_settings.connections: print_connection_profile_blocking(dbus_connection_path) def print_connection_profile_blocking(connection_path: str) -> None: """Show the use of NetworkConnectionSettings(path).connection_profile()""" profile = NetworkConnectionSettings(connection_path).connection_profile() print("-------------------------------------------------------------") print("name:", profile.connection.connection_id) print("uuid:", profile.connection.uuid) print("type:", profile.connection.connection_type) if profile.connection.interface_name: print(" interface-name:", profile.connection.interface_name) if profile.ipv4: print("ipv4: method:", profile.ipv4.method) if profile.ipv4.address_data: for address in profile.ipv4.address_data: print(f' ipaddr: {address.address}/{address.prefix}') if profile.ipv4.route_metric: print(f' route-metric: {profile.ipv4.route_metric}') if profile.ipv6: print("ipv6: method:", profile.ipv6.method) if profile.connection.connection_type == ConnectionType.WIFI: assert profile.wireless assert profile.wireless.ssid print("ssid:", profile.wireless.ssid.decode()) if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) list_connection_profiles_blocking() python-sdbus-networkmanager-2.0rc2/examples/block/netdevinfo.py000077500000000000000000000103751442124064700251030ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Example to list the active IPv4 protocol configuration of network devices # and the current status of WiFi adapters # # For IPv4 and org.freedesktop.NetworkManager.Device.Wireless see: # https://networkmanager.dev/docs/api/latest/settings-ipv4.html # https://networkmanager.dev/docs/api/latest/ref-dbus-devices.html import sdbus from sdbus_block.networkmanager import ( ConnectionType, NetworkConnectionSettings, NetworkManager, NetworkManagerSettings, NetworkDeviceGeneric, IPv4Config, DeviceType, NetworkDeviceWireless, WiFiOperationMode, AccessPoint, ) from typing import Any, Dict, List, Optional, Tuple NetworkManagerAddressData = List[Dict[str, Tuple[str, Any]]] def get_most_recent_connection_id(ifname: str, dev_type: str) -> Optional[str]: """Return the most-recently used connection_id for this device Besides getting the currently active connection, this will succeed in getting the most recent connection when a device is not connected at the moment this function is executed. It uses getattr(ConnectionType, dev_type) to get the connection_type used for connection_profiles for this DeviceType. With a slight modification, this could return the most recent connections of the given device, ordered by the time of the last use of them. """ settings_service = NetworkManagerSettings() connection_paths: List[str] = settings_service.connections conns = {} for connection_path in connection_paths: connection_manager = NetworkConnectionSettings(connection_path) connection = connection_manager.connection_profile().connection # Filter connection profiles matching the connection type for the device: if connection.connection_type != getattr(ConnectionType, dev_type): continue # If the interface_name of a connection profiles is set, it must match: if connection.interface_name and connection.interface_name != ifname: continue # If connection.timestamp is not set, it was never active. Set it to 0: if not connection.timestamp: connection.timestamp = 0 # Record the connection_ids of the matches, and timestamp is the key: conns[connection.timestamp] = connection.connection_id if not len(conns): return None # Returns the connection_id of the highest timestamp which was found: return conns.get(max(conns.keys())) def list_networkdevice_details_blocking() -> None: for device_path in NetworkManager().get_devices(): generic_device = NetworkDeviceGeneric(device_path) device_ip4_conf_path: str = generic_device.ip4_config if device_ip4_conf_path == "/": continue if not generic_device.managed: continue dev_type = DeviceType(generic_device.device_type).name if dev_type == DeviceType.BRIDGE.name: continue dev_name = generic_device.interface ip4_conf = IPv4Config(device_ip4_conf_path) gateway: str = ip4_conf.gateway print("Type: ", dev_type.title()) print("Name: ", dev_name) if gateway: print("Gateway:", gateway) address_data: NetworkManagerAddressData = ip4_conf.address_data for inetaddr in address_data: print(f'Address: {inetaddr["address"][1]}/{inetaddr["prefix"][1]}') nameservers: NetworkManagerAddressData = ip4_conf.nameserver_data for dns in nameservers: print("DNS: ", dns["address"][1]) if dev_type == DeviceType.WIFI.name: wifi = NetworkDeviceWireless(device_path) print("Wifi: ", WiFiOperationMode(wifi.mode).name.title()) ap = AccessPoint(wifi.active_access_point) ssid: bytes = ap.ssid if ssid: print("SSID: ", ssid.decode("utf-8", "ignore")) if ap.strength: print("Signal: ", ap.strength) connection_id = get_most_recent_connection_id(dev_name, dev_type) if connection_id: print("Profile:", connection_id) print("") if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) list_networkdevice_details_blocking() python-sdbus-networkmanager-2.0rc2/examples/block/update-connection.py000066400000000000000000000036631442124064700263600ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # # Update a property of a connection profile, looked up by connection id # # The IPv4 settings of connections profiles are documented here: # https://networkmanager.dev/docs/api/latest/settings-ipv4.html # import sdbus from functools import partial from sdbus_block.networkmanager import NetworkManagerSettings from sdbus_block.networkmanager import NetworkConnectionSettings from pprint import pprint from typing import Any, Dict def update_connection(args: Dict[str, Any]) -> None: """Update the settings for [key][entry] of the 1st matching connection""" con = NetworkManagerSettings().get_connections_by_id(args["connection_id"]) settings_domain, setting = args["connection_setting"] if con: connection_settings = NetworkConnectionSettings(con[0]) properties = connection_settings.get_settings() # For compatibility with old tools, NM adds and prefers them, delete: properties["ipv4"].pop("addresses") # -> Use ["ipv4"]["address-data"] properties["ipv4"].pop("routes") # ----> Use ["ipv4"]["route-data"] # Update the setting's value in the given configuration group: properties[settings_domain][setting] = args["value"] connection_settings.update(properties) print(f'Updated {properties["connection"]["uuid"]}.{settings_domain}:') partial(pprint, sort_dicts=False)(properties[settings_domain]) else: print(f"No connection matching {id}") if __name__ == "__main__": sdbus.set_default_bus(sdbus.sd_bus_open_system()) args = { # Set MyConnectionExample.ipv4.dns-search to "domain1.com,domain2.com": "connection_id": "MyConnectionExample", "connection_setting": ("ipv4", "dns-search"), # "as" is the so-called DBus signature, it means "array of strings": "value": ("as", ["domain1.com", "domain2.com"]), } update_connection(args) python-sdbus-networkmanager-2.0rc2/mypy.ini000066400000000000000000000000421442124064700211420ustar00rootroot00000000000000[mypy] namespace_packages = true python-sdbus-networkmanager-2.0rc2/pytest.ini000066400000000000000000000014571442124064700215070ustar00rootroot00000000000000[pytest] # # Newer version of pytest-asyncio issue a DeprecationWarning unless # asyncio_mode is specified. This is because it is planned to change # the legacy default of automatically decorating async fixtures from # automatc to strict (only all functions and fixtures have to be marked). # # But only very recent versions of pytest-asyncio versions support # the asyncio_mode configuration setting and then issue a config warning, # which can't be filtered. # # Thus, filter the Deprecationwarning of pytest-asyncio for some time # until all users can be assumed to use the latest pytest-asyncio. # filterwarnings = ignore:The 'asyncio_mode' default value will change to 'strict' in future, please explicitly use 'asyncio_mode=strict' or 'asyncio_mode=auto' in pytest configuration file.:DeprecationWarning python-sdbus-networkmanager-2.0rc2/requirements.txt000066400000000000000000000000161442124064700227300ustar00rootroot00000000000000sdbus>=0.10.2 python-sdbus-networkmanager-2.0rc2/sdbus_async/000077500000000000000000000000001442124064700217645ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/000077500000000000000000000000001442124064700250105ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/__init__.py000066400000000000000000000323441442124064700271270ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from .enums import ( AccessPointCapabilities, BluetoothCapabilities, ConnectionFlags, ConnectionState, ConnectionStateFlags, ConnectionStateReason, ConnectionType, ConnectivityState, DeviceCapabilities, DeviceInterfaceFlags, DeviceMetered, DeviceState, DeviceStateReason, DeviceType, IpTunnelMode, ModemCapabilities, NetworkManagerConnectivityState, NetworkManagerState, SecretAgentCapabilities, VpnFailure, VpnState, WiFiOperationMode, WirelessCapabilities, WpaSecurityFlags, ) from .exceptions import ( NetworkManagerAlreadyAsleepOrAwakeError, NetworkManagerAlreadyEnabledOrDisabledError, NetworkManagerBaseError, NetworkManagerConnectionAlreadyActiveError, NetworkManagerConnectionNotActiveError, NetworkManagerConnectionNotAvailableError, NetworkManagerDependencyFailedError, NetworkManagerFailedError, NetworkManagerInvalidArgumentsError, NetworkManagerMissingPluginError, NetworkManagerPermissionDeniedError, NetworkManagerUnknownConnectionError, NetworkManagerUnknownDeviceError, NetworkManagerUnknownLogDomainError, NetworkManagerUnknownLogLevelError, NmAgentManagerFailedError, NmAgentManagerInvalidIdentifierError, NmAgentManagerNoSecretsError, NmAgentManagerNotRegisteredError, NmAgentManagerPermissionDeniedError, NmAgentManagerUserCanceledError, NmConnectionFailedError, NmConnectionInvalidPropertyError, NmConnectionInvalidSettingError, NmConnectionMissingPropertyError, NmConnectionMissingSettingError, NmConnectionPropertyNotFoundError, NmConnectionPropertyNotSecretError, NmConnectionSettingNotFoundError, NmDeviceCreationFailedError, NmDeviceFailedError, NmDeviceIncompatibleConnectionError, NmDeviceInvalidArgumentError, NmDeviceInvalidConnectionError, NmDeviceMissingDependenciesError, NmDeviceNotActiveError, NmDeviceNotAllowedError, NmDeviceNotSoftwareError, NmDeviceSpecificObjectNotFoundError, NmDeviceVersionIdMismatchError, NmSecretManagerAgentCanceledError, NmSecretManagerFailedError, NmSecretManagerInvalidConnectionError, NmSecretManagerNoSecretsError, NmSecretManagerPermissionDeniedError, NmSecretManagerUserCanceledError, NmSettingsFailedError, NmSettingsInvalidArgumentsError, NmSettingsInvalidConnectionError, NmSettingsInvalidHostnameError, NmSettingsNotSupportedError, NmSettingsPermissionDeniedError, NmSettingsReadOnlyConnectionError, NmSettingsUuidExistsError, NmVpnPluginAlreadyStartedError, NmVpnPluginAlreadyStoppedError, NmVpnPluginBadArgumentsError, NmVpnPluginFailedError, NmVpnPluginInteractiveNotSupportedError, NmVpnPluginInvalidConnectionError, NmVpnPluginLaunchFailedError, NmVpnPluginStartingInProgressError, NmVpnPluginStoppingInProgressError, NmVpnPluginWrongStateError, ) from .interfaces_devices import ( NetworkManagerDeviceBluetoothInterfaceAsync, NetworkManagerDeviceBondInterfaceAsync, NetworkManagerDeviceBridgeInterfaceAsync, NetworkManagerDeviceGenericInterfaceAsync, NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceIPTunnelInterfaceAsync, NetworkManagerDeviceLowpanInterfaceAsync, NetworkManagerDeviceMacsecInterfaceAsync, NetworkManagerDeviceMacvlanInterfaceAsync, NetworkManagerDeviceModemInterfaceAsync, NetworkManagerDeviceOlpcMeshInterfaceAsync, NetworkManagerDeviceOvsBridgeInterfaceAsync, NetworkManagerDeviceOvsPortInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceTeamInterfaceAsync, NetworkManagerDeviceTunInterfaceAsync, NetworkManagerDeviceVethInterfaceAsync, NetworkManagerDeviceVlanInterfaceAsync, NetworkManagerDeviceVrfInterfaceAsync, NetworkManagerDeviceVxlanInterfaceAsync, NetworkManagerDeviceWifiP2PInterfaceAsync, NetworkManagerDeviceWiredInterfaceAsync, NetworkManagerDeviceWireGuardInterfaceAsync, NetworkManagerDeviceWirelessInterfaceAsync, NetworkManagerPPPInterfaceAsync, ) from .interfaces_other import ( NetworkManagerAccessPointInterfaceAsync, NetworkManagerCheckpointInterfaceAsync, NetworkManagerConnectionActiveInterfaceAsync, NetworkManagerDHCP4ConfigInterfaceAsync, NetworkManagerDHCP6ConfigInterfaceAsync, NetworkManagerDnsManagerInterfaceAsync, NetworkManagerInterfaceAsync, NetworkManagerIP4ConfigInterfaceAsync, NetworkManagerIP6ConfigInterfaceAsync, NetworkManagerSecretAgentInterfaceAsync, NetworkManagerSecretAgentManagerInterfaceAsync, NetworkManagerSettingsConnectionInterfaceAsync, NetworkManagerSettingsInterfaceAsync, NetworkManagerVPNConnectionInterfaceAsync, NetworkManagerVPNPluginInterfaceAsync, NetworkManagerWifiP2PPeerInterfaceAsync, ) from .objects import ( AccessPoint, ActiveConnection, ActiveVPNConnection, ConfigCheckpoint, DHCPv4Config, DHCPv6Config, IPv4Config, IPv6Config, NetworkConnectionSettings, NetworkDeviceBluetooth, NetworkDeviceBond, NetworkDeviceBridge, NetworkDeviceGeneric, NetworkDeviceIpTunnel, NetworkDeviceMacsec, NetworkDeviceMacvlan, NetworkDeviceModem, NetworkDeviceOlpcMesh, NetworkDeviceOpenVSwitchBridge, NetworkDeviceOpenVSwitchPort, NetworkDevicePPP, NetworkDeviceTeam, NetworkDeviceTun, NetworkDeviceVeth, NetworkDeviceVlan, NetworkDeviceVrf, NetworkDeviceVxlan, NetworkDeviceWifiP2P, NetworkDeviceWired, NetworkDeviceWireGuard, NetworkDeviceWireless, NetworkManager, NetworkManagerAgentManager, NetworkManagerDnsManager, NetworkManagerSettings, WiFiP2PPeer, ) from .types import ( NetworkManagerConnectionProperties, NetworkManagerSetting, NetworkManagerSettingsDomain, SettingsDict, ) DEVICE_TYPE_TO_CLASS = { DeviceType.ETHERNET: NetworkDeviceWired, DeviceType.WIFI: NetworkDeviceWireless, DeviceType.BLUETOOTH: NetworkDeviceBluetooth, DeviceType.OLPC_MESH: NetworkDeviceOlpcMesh, DeviceType.VETH: NetworkDeviceVeth, DeviceType.WIREGUARD: NetworkDeviceWireGuard, DeviceType.PPP: NetworkDevicePPP, DeviceType.BRIDGE: NetworkDeviceBridge, DeviceType.MODEM: NetworkDeviceModem, } __all__ = ( # .enums 'AccessPointCapabilities', 'BluetoothCapabilities', 'ConnectionFlags', 'ConnectionState', 'ConnectionStateFlags', 'ConnectionStateReason', 'ConnectionType', 'ConnectivityState', 'DeviceCapabilities', 'DeviceInterfaceFlags', 'DeviceMetered', 'DeviceState', 'DeviceStateReason', 'DeviceType', 'IpTunnelMode', 'ModemCapabilities', 'NetworkManagerConnectivityState', 'NetworkManagerState', 'SecretAgentCapabilities', 'VpnFailure', 'VpnState', 'WiFiOperationMode', 'WirelessCapabilities', 'WpaSecurityFlags', # .exceptions 'NetworkManagerAlreadyAsleepOrAwakeError', 'NetworkManagerAlreadyEnabledOrDisabledError', 'NetworkManagerBaseError', 'NetworkManagerConnectionAlreadyActiveError', 'NetworkManagerConnectionNotActiveError', 'NetworkManagerConnectionNotAvailableError', 'NetworkManagerDependencyFailedError', 'NetworkManagerFailedError', 'NetworkManagerInvalidArgumentsError', 'NetworkManagerMissingPluginError', 'NetworkManagerPermissionDeniedError', 'NetworkManagerUnknownConnectionError', 'NetworkManagerUnknownDeviceError', 'NetworkManagerUnknownLogDomainError', 'NetworkManagerUnknownLogLevelError', 'NmAgentManagerFailedError', 'NmAgentManagerInvalidIdentifierError', 'NmAgentManagerNoSecretsError', 'NmAgentManagerNotRegisteredError', 'NmAgentManagerPermissionDeniedError', 'NmAgentManagerUserCanceledError', 'NmConnectionFailedError', 'NmConnectionInvalidPropertyError', 'NmConnectionInvalidSettingError', 'NmConnectionMissingPropertyError', 'NmConnectionMissingSettingError', 'NmConnectionPropertyNotFoundError', 'NmConnectionPropertyNotSecretError', 'NmConnectionSettingNotFoundError', 'NmDeviceCreationFailedError', 'NmDeviceFailedError', 'NmDeviceIncompatibleConnectionError', 'NmDeviceInvalidArgumentError', 'NmDeviceInvalidConnectionError', 'NmDeviceMissingDependenciesError', 'NmDeviceNotActiveError', 'NmDeviceNotAllowedError', 'NmDeviceNotSoftwareError', 'NmDeviceSpecificObjectNotFoundError', 'NmDeviceVersionIdMismatchError', 'NmSecretManagerAgentCanceledError', 'NmSecretManagerFailedError', 'NmSecretManagerInvalidConnectionError', 'NmSecretManagerNoSecretsError', 'NmSecretManagerPermissionDeniedError', 'NmSecretManagerUserCanceledError', 'NmSettingsFailedError', 'NmSettingsInvalidArgumentsError', 'NmSettingsInvalidConnectionError', 'NmSettingsInvalidHostnameError', 'NmSettingsNotSupportedError', 'NmSettingsPermissionDeniedError', 'NmSettingsReadOnlyConnectionError', 'NmSettingsUuidExistsError', 'NmVpnPluginAlreadyStartedError', 'NmVpnPluginAlreadyStoppedError', 'NmVpnPluginBadArgumentsError', 'NmVpnPluginFailedError', 'NmVpnPluginInteractiveNotSupportedError', 'NmVpnPluginInvalidConnectionError', 'NmVpnPluginLaunchFailedError', 'NmVpnPluginStartingInProgressError', 'NmVpnPluginStoppingInProgressError', 'NmVpnPluginWrongStateError', # .interfaces_devices 'NetworkManagerDeviceBluetoothInterfaceAsync', 'NetworkManagerDeviceBondInterfaceAsync', 'NetworkManagerDeviceBridgeInterfaceAsync', 'NetworkManagerDeviceGenericInterfaceAsync', 'NetworkManagerDeviceInterfaceAsync', 'NetworkManagerDeviceIPTunnelInterfaceAsync', 'NetworkManagerDeviceLowpanInterfaceAsync', 'NetworkManagerDeviceMacsecInterfaceAsync', 'NetworkManagerDeviceMacvlanInterfaceAsync', 'NetworkManagerDeviceModemInterfaceAsync', 'NetworkManagerDeviceOlpcMeshInterfaceAsync', 'NetworkManagerDeviceOvsBridgeInterfaceAsync', 'NetworkManagerDeviceOvsPortInterfaceAsync', 'NetworkManagerDeviceStatisticsInterfaceAsync', 'NetworkManagerDeviceTeamInterfaceAsync', 'NetworkManagerDeviceTunInterfaceAsync', 'NetworkManagerDeviceVethInterfaceAsync', 'NetworkManagerDeviceVlanInterfaceAsync', 'NetworkManagerDeviceVrfInterfaceAsync', 'NetworkManagerDeviceVxlanInterfaceAsync', 'NetworkManagerDeviceWifiP2PInterfaceAsync', 'NetworkManagerDeviceWiredInterfaceAsync', 'NetworkManagerDeviceWireGuardInterfaceAsync', 'NetworkManagerDeviceWirelessInterfaceAsync', 'NetworkManagerPPPInterfaceAsync', # .interfaces_other 'NetworkManagerAccessPointInterfaceAsync', 'NetworkManagerCheckpointInterfaceAsync', 'NetworkManagerConnectionActiveInterfaceAsync', 'NetworkManagerDHCP4ConfigInterfaceAsync', 'NetworkManagerDHCP6ConfigInterfaceAsync', 'NetworkManagerDnsManagerInterfaceAsync', 'NetworkManagerInterfaceAsync', 'NetworkManagerIP4ConfigInterfaceAsync', 'NetworkManagerIP6ConfigInterfaceAsync', 'NetworkManagerSecretAgentInterfaceAsync', 'NetworkManagerSecretAgentManagerInterfaceAsync', 'NetworkManagerSettingsConnectionInterfaceAsync', 'NetworkManagerSettingsInterfaceAsync', 'NetworkManagerVPNConnectionInterfaceAsync', 'NetworkManagerVPNPluginInterfaceAsync', 'NetworkManagerWifiP2PPeerInterfaceAsync', # .objects 'AccessPoint', 'ActiveConnection', 'ActiveVPNConnection', 'ConfigCheckpoint', 'DHCPv4Config', 'DHCPv6Config', 'IPv4Config', 'IPv6Config', 'NetworkConnectionSettings', 'NetworkDeviceBluetooth', 'NetworkDeviceBond', 'NetworkDeviceBridge', 'NetworkDeviceGeneric', 'NetworkDeviceIpTunnel', 'NetworkDeviceMacsec', 'NetworkDeviceMacvlan', 'NetworkDeviceModem', 'NetworkDeviceOlpcMesh', 'NetworkDeviceOpenVSwitchBridge', 'NetworkDeviceOpenVSwitchPort', 'NetworkDevicePPP', 'NetworkDeviceTeam', 'NetworkDeviceTun', 'NetworkDeviceVeth', 'NetworkDeviceVlan', 'NetworkDeviceVrf', 'NetworkDeviceVxlan', 'NetworkDeviceWifiP2P', 'NetworkDeviceWired', 'NetworkDeviceWireGuard', 'NetworkDeviceWireless', 'NetworkManager', 'NetworkManagerAgentManager', 'NetworkManagerDnsManager', 'NetworkManagerSettings', 'WiFiP2PPeer', # .types 'NetworkManagerConnectionProperties', 'NetworkManagerSetting', 'NetworkManagerSettingsDomain', 'SettingsDict', 'DEVICE_TYPE_TO_CLASS', ) python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/enums.py000066400000000000000000000345401442124064700265170ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from enum import Enum, IntEnum, IntFlag class AccessPointCapabilities(IntFlag): """Wi-Fi Access point capabilities Flags: * NONE * PRIVACY * WPS * WPS_BUTTON * WPS_PIN """ NONE = 0x0 PRIVACY = 0x1 WPS = 0x2 WPS_BUTTON = 0x4 WPS_PIN = 0x8 class WpaSecurityFlags(IntFlag): """WPA (WiFi protected Access) encryption and authentication types Flags: * NONE * P2P_WEP40 * P2P_WEP104 * P2P_TKIP * P2P_CCMP * BROADCAST_WEP40 * BROADCAST_WEP104 * BROADCAST_TKIP * BROADCAST_CCMP * AUTH_PSK * AUTH_802_1X * AUTH_SAE * AUTH_OWE * AUTH_OWE_TM * AUTH_EAP_SUITE_B """ NONE = 0x0 P2P_WEP40 = 0x1 P2P_WEP104 = 0x2 P2P_TKIP = 0x4 P2P_CCMP = 0x8 BROADCAST_WEP40 = 0x10 BROADCAST_WEP104 = 0x20 BROADCAST_TKIP = 0x40 BROADCAST_CCMP = 0x80 AUTH_PSK = 0x100 AUTH_802_1X = 0x200 AUTH_SAE = 0x400 AUTH_OWE = 0x800 AUTH_OWE_TM = 0x1000 AUTH_EAP_SUITE_B = 0x2000 class WiFiOperationMode(IntEnum): """Operation mode of WiFi access point * UNKNOWN * ADHOC * INFRASTRUCTURE * AP * MESH """ UNKNOWN = 0 ADHOC = 1 INFRASTRUCTURE = 2 AP = 3 MESH = 4 class SecretAgentCapabilities(IntFlag): """Secret agent capabilities Flags: * NONE * VPN_HINTS """ NONE = 0x0 VPN_HINTS = 0x1 class ConnectionState(IntEnum): """State of the connection * UNKNOWN * ACTIVATING * ACTIVATED * DEACTIVATING * DEACTIVATED """ UNKNOWN = 0 ACTIVATING = 1 ACTIVATED = 2 DEACTIVATING = 3 DEACTIVATED = 4 class ConnectionStateFlags(IntFlag): """State of connection flags Flags: * NONE * IS_MASTER * IS_SLAVE * LAYER2_READY * IP4_READY * IP6_READY * MASTER_HAS_SLAVES * LIFE_TIME_BOUND_TO_PROFILE_VISIBILITY * EXTERNAL """ NONE = 0x0 IS_MASTER = 0x1 IS_SLAVE = 0x2 LAYER2_READY = 0x4 IP4_READY = 0x8 IP6_READY = 0x10 MASTER_HAS_SLAVES = 0x20 LIFE_TIME_BOUND_TO_PROFILE_VISIBILITY = 0x40 EXTERNAL = 0x80 class ConnectionStateReason(IntEnum): """Connection state change reason * UNKNOWN * NONE * USER_DISCONNECTED * DEVICE_DISCONNECTED * SERVICE_STOPPED * IP_CONFIG_INVALID * CONNECT_TIMEOUT * SERVICE_START_TIMEOUT * SERVICE_START_FAILED * NO_SECRETS * LOGIN_FAILED * CONNECTION_REMOVED * DEPENDENCY_FAILED * DEVICE_REALIZE_FAILED * DEVICE_REMOVED """ UNKNOWN = 0 NONE = 1 USER_DISCONNECTED = 2 DEVICE_DISCONNECTED = 3 SERVICE_STOPPED = 4 IP_CONFIG_INVALID = 5 CONNECT_TIMEOUT = 6 SERVICE_START_TIMEOUT = 7 SERVICE_START_FAILED = 8 NO_SECRETS = 9 LOGIN_FAILED = 10 CONNECTION_REMOVED = 11 DEPENDENCY_FAILED = 12 DEVICE_REALIZE_FAILED = 13 DEVICE_REMOVED = 14 class BluetoothCapabilities(IntFlag): """Bluetooth Capabilities Flags: * NONE * DIAL_UP * NETWORK_ACCESS_POINT """ NONE = 0x0 DIAL_UP = 0x1 NETWORK_ACCESS_POINT = 0x2 class IpTunnelMode(IntEnum): """Mode of IP tunnel * UNKNOWN * IP_IP * GRE * SIT * ISATAP * VTI * IP6_IP6 * IP_IP6 * IP6_GRE * VTI6 * GRE_TAP * IP6_GRE_TAP """ UNKNOWN = 0 IP_IP = 1 GRE = 2 SIT = 3 ISATAP = 4 VTI = 5 IP6_IP6 = 6 IP_IP6 = 7 IP6_GRE = 8 VTI6 = 9 GRE_TAP = 10 IP6_GRE_TAP = 11 class ModemCapabilities(IntFlag): """Modem capabilities flags Flags: * NONE * ANALOG_WIRE * CDMA * GSM * LTE """ NONE = 0x0 ANALOG_WIRE = 0x1 CDMA = 0x2 GSM = 0x4 LTE = 0x8 class WirelessCapabilities(IntFlag): """Wireless device capabilities flags Flags: * NONE * CIPHER_WEP40 * CIPHER_WEP104 * CIPHER_TKIP * CIPHER_CCMP * WPA * WPA2 * AP * ADHOC * FREQ_VALID * FREQ_2GHZ * FREQ_5GHZ * MESH * IBSS_WPA2 """ NONE = 0x0 CIPHER_WEP40 = 0x1 CIPHER_WEP104 = 0x2 CIPHER_TKIP = 0x4 CIPHER_CCMP = 0x8 WPA = 0x10 WPA2 = 0x20 AP = 0x40 ADHOC = 0x80 FREQ_VALID = 0x100 FREQ_2GHZ = 0x200 FREQ_5GHZ = 0x400 MESH = 0x800 IBSS_WPA2 = 0x2000 class DeviceCapabilities(IntFlag): """Device Capabilities Flags: * NONE * SUPPORTED * CARRIER_DETECTABLE * IS_SOFTWARE * CAN_SRIOV """ NONE = 0x0 SUPPORTED = 0x1 CARRIER_DETECTABLE = 0x2 IS_SOFTWARE = 0x4 CAN_SRIOV = 0x8 class DeviceState(IntEnum): """Device State * UNKNOWN * UNMANAGED * UNAVAILABLE * DISCONNECTED * PREPARE * CONFIG * NEED_AUTH * IP_CONFIG * IP_CHECK * SECONDARIES * ACTIVATED * DEACTIVATING * FAILED """ UNKNOWN = 0 UNMANAGED = 10 UNAVAILABLE = 20 DISCONNECTED = 30 PREPARE = 40 CONFIG = 50 NEED_AUTH = 60 IP_CONFIG = 70 IP_CHECK = 80 SECONDARIES = 90 ACTIVATED = 100 DEACTIVATING = 110 FAILED = 120 class DeviceStateReason(IntEnum): """Device State reason * NONE * UNKNOWN * NOW_MANAGED * NOW_UNMANAGED * CONFIG_FAILED * IP_CONFIG_UNAVAILABLE * IP_CONFIG_EXPIRED * NO_SECRETS * SUPPLICANT_DISCONNECT * SUPPLICANT_CONFIG_FAILED * SUPPLICANT_FAILED * SUPPLICANT_TIMEOUT * PPP_START_FAILED * PPP_DISCONNECT * PPP_FAILED * DHCP_START_FAILED * DHCP_ERROR * DHCP_FAILED * SHARED_START_FAILED * SHARED_FAILED * AUTOIP_START_FAILED * AUTOIP_ERROR * AUTOIP_FAILED * MODEM_BUSY * MODEM_NO_DIAL_TONE * MODEM_NO_CARRIER * MODEM_DIAL_TIMEOUT * MODEM_DIAL_FAILED * MODEM_INIT_FAILED * GSM_APN_FAILED * GSM_REGISTRATION_NOT_SEARCHING * GSM_REGISTRATION_DENIED * GSM_REGISTRATION_TIMEOUT * GSM_REGISTRATION_FAILED * GSM_PIN_CHECK_FAILED * FIRMWARE_MISSING * REMOVED * SLEEPING * CONNECTION_REMOVED * USER_REQUESTED * CARRIER * CONNECTION_ASSUMED * SUPPLICANT_AVAILABLE * MODEM_NOT_FOUND * BT_FAILED * GSM_SIM_NOT_INSERTED * GSM_SIM_PIN_REQUIRED * GSM_SIM_PUK_REQUIRED * GSM_SIM_WRONG * INFINIBAND_MODE * DEPENDENCY_FAILED * BR2684_FAILED * MODEM_MANAGER_UNAVAILABLE * SSID_NOT_FOUND * SECONDARY_CONNECTION_FAILED * DCB_FCOE_FAILED * TEAMD_CONTROL_FAILED * MODEM_FAILED * MODEM_AVAILABLE * SIM_PIN_INCORRECT * NEW_ACTIVATION * PARENT_CHANGED * PARENT_MANAGED_CHANGED * OVSDB_FAILED * IP_ADDRESS_DUPLICATE * IP_METHOD_UNSUPPORTED * SRIOV_CONFIGURATION_FAILED * PEER_NOT_FOUND """ UNKNOWN = 1 NOW_MANAGED = 2 NOW_UNMANAGED = 3 CONFIG_FAILED = 4 IP_CONFIG_UNAVAILABLE = 5 IP_CONFIG_EXPIRED = 6 NO_SECRETS = 7 SUPPLICANT_DISCONNECT = 8 SUPPLICANT_CONFIG_FAILED = 9 SUPPLICANT_FAILED = 10 SUPPLICANT_TIMEOUT = 11 PPP_START_FAILED = 12 PPP_DISCONNECT = 13 PPP_FAILED = 14 DHCP_START_FAILED = 15 DHCP_ERROR = 16 DHCP_FAILED = 17 SHARED_START_FAILED = 18 SHARED_FAILED = 19 AUTOIP_START_FAILED = 20 AUTOIP_ERROR = 21 AUTOIP_FAILED = 22 MODEM_BUSY = 23 MODEM_NO_DIAL_TONE = 24 MODEM_NO_CARRIER = 25 MODEM_DIAL_TIMEOUT = 26 MODEM_DIAL_FAILED = 27 MODEM_INIT_FAILED = 28 GSM_APN_FAILED = 29 GSM_REGISTRATION_NOT_SEARCHING = 30 GSM_REGISTRATION_DENIED = 31 GSM_REGISTRATION_TIMEOUT = 32 GSM_REGISTRATION_FAILED = 33 GSM_PIN_CHECK_FAILED = 34 FIRMWARE_MISSING = 35 REMOVED = 36 SLEEPING = 37 CONNECTION_REMOVED = 38 USER_REQUESTED = 39 CARRIER = 40 CONNECTION_ASSUMED = 41 SUPPLICANT_AVAILABLE = 42 MODEM_NOT_FOUND = 43 BT_FAILED = 44 GSM_SIM_NOT_INSERTED = 45 GSM_SIM_PIN_REQUIRED = 46 GSM_SIM_PUK_REQUIRED = 47 GSM_SIM_WRONG = 48 INFINIBAND_MODE = 49 DEPENDENCY_FAILED = 50 BR2684_FAILED = 51 MODEM_MANAGER_UNAVAILABLE = 52 SSID_NOT_FOUND = 53 SECONDARY_CONNECTION_FAILED = 54 DCB_FCOE_FAILED = 55 TEAMD_CONTROL_FAILED = 56 MODEM_FAILED = 57 MODEM_AVAILABLE = 58 SIM_PIN_INCORRECT = 59 NEW_ACTIVATION = 60 PARENT_CHANGED = 61 PARENT_MANAGED_CHANGED = 62 OVSDB_FAILED = 63 IP_ADDRESS_DUPLICATE = 64 IP_METHOD_UNSUPPORTED = 65 SRIOV_CONFIGURATION_FAILED = 66 PEER_NOT_FOUND = 67 # Connection Types, e.g. from connecion_profile.connection.type: # # There is no central list of all connection types in NM. # The best bet is to look for nm_connection_is_type() checks which use # NM_SETTING_(TYPE)_SETTING_NAME #defines (which are fined used for # settings for this connection-type. One connection_type can have several # of such settings groups, so we have to filter those to get the strings: # # Generated from NetworkManager source using: # grep -r nm_connection_is_type src/| # sed -n 's/.*NM_SETTING_/NM_SETTING_/;s/_SETTING_NAME.*/=/p' | # sort -u >.connection_is_type # grep -hr define.*_SETTING_NAME src/| # sed 's/#define //;s/_SETTING_NAME//;s/ /=/' >.setting_defines # grep -f .connection_is_type .setting_defines | # sed 's/NM_SETTING_/ /;s/6L/SIXL/;/GENERIC/d;s/=/ = /' # Manual edit: This resulted in WIRED instead of ETHERNET, but # ETHERNET is the name used for DeviceType, so use ETHERNET instead to # be able to lookup connection profiles for Ethernet using DeviceType. # # One src/core/nm-device-*.c can support more than one ConnectionType, # thus there are more ConnectionTypes than DeviceTypes: # From NetworkManager-1.35: class ConnectionType(str, Enum): """Connection Types * ADSL * BLUETOOTH * BOND * BRIDGE * CDMA * DUMMY * ETHERNET * MODEM * INFINIBAND * IP_TUNNEL * MACSEC * MACVLAN * OLPC_MESH * OVS_BRIDGE * OVS_INTERFACE * OVS_INTERFACE * PPPOE * SIXLOWPAN * TEAM * TUN * VETH * VLAN * VPN * VRF * VXLAN * WIFI_P2P * WIREGUARD * WIFI * WPAN """ ADSL = "adsl" BLUETOOTH = "bluetooth" BOND = "bond" BRIDGE = "bridge" CDMA = "cdma" DUMMY = "dummy" ETHERNET = "802-3-ethernet" MODEM = "gsm" INFINIBAND = "infiniband" IP_TUNNEL = "ip-tunnel" MACSEC = "macsec" MACVLAN = "macvlan" OLPC_MESH = "802-11-olpc-mesh" OVS_BRIDGE = "ovs-bridge" OVS_INTERFACE = "ovs-interface" OVS_PORT = "ovs-port" PPPOE = "pppoe" SIXLOWPAN = "6lowpan" TEAM = "team" TUN = "tun" VETH = "veth" VLAN = "vlan" VPN = "vpn" VRF = "vrf" VXLAN = "vxlan" WIFI_P2P = "wifi-p2p" WIREGUARD = "wireguard" WIFI = "802-11-wireless" WPAN = "wpan" class DeviceType(IntEnum): """Device Type * UNKNOWN * ETHERNET * WIFI * UNUSED1 * UNUSED2 * BLUETOOTH * OLPC_MESH * WIMAX * MODEM * INFINIBAND * BOND * VLAN * ADSL * BRIDGE * GENERIC * TEAM * TUN * IP_TUNNEL * MACVLAN * VXLAN * VETH * MACSEC * DUMMY * PPP * OVS_INTERFACE * OVS_PORT * OVS_BRIDGE * WPAN * SIXLOWPAN * WIREGUARD * WIFI_P2P * VRF """ UNKNOWN = 0 ETHERNET = 1 WIFI = 2 UNUSED1 = 3 UNUSED2 = 4 BLUETOOTH = 5 OLPC_MESH = 6 WIMAX = 7 MODEM = 8 INFINIBAND = 9 BOND = 10 VLAN = 11 ADSL = 12 BRIDGE = 13 GENERIC = 14 TEAM = 15 TUN = 16 IP_TUNNEL = 17 MACVLAN = 18 VXLAN = 19 VETH = 20 MACSEC = 21 DUMMY = 22 PPP = 23 OVS_INTERFACE = 24 OVS_PORT = 25 OVS_BRIDGE = 26 WPAN = 27 SIXLOWPAN = 28 WIREGUARD = 29 WIFI_P2P = 30 VRF = 31 class DeviceMetered(IntEnum): """Device Metered state * UNKNOWN * YES * NO * GUESS_YES * GUESS_NO """ UNKNOWN = 0 YES = 1 NO = 2 GUESS_YES = 3 GUESS_NO = 4 class ConnectivityState(IntEnum): """Connectivity state * UNKNOWN * NONE * PORTAL * LIMITED * FULL """ UNKNOWN = 0 NONE = 1 PORTAL = 2 LIMITED = 3 FULL = 4 class DeviceInterfaceFlags(IntFlag): """Device network interface flags Flags: * NONE * UP * LOWER_UP * CARRIER """ NONE = 0x0 UP = 0x1 LOWER_UP = 0x2 CARRIER = 0x10000 class ConnectionFlags(IntFlag): """Connection flags Flags * NONE * UNSAVED * GENERATED * VOLATILE * EXTERNAL """ NONE = 0x0 UNSAVED = 0x1 GENERATED = 0x2 VOLATILE = 0x4 EXTERNAL = 0x8 class VpnState(IntEnum): """VPN State * UNKNOWN * INIT * SHUTDOWN * STARTING * STARTED * STOPPING * STOPPED """ UNKNOWN = 0 INIT = 1 SHUTDOWN = 2 STARTING = 3 STARTED = 4 STOPPING = 5 STOPPED = 6 class VpnFailure(IntEnum): """VPN Failure * LOGIN_FAILURE * CONNECT_FAILED * BAD_IP_CONFIG """ LOGIN_FAILURE = 0 CONNECT_FAILED = 1 BAD_IP_CONFIG = 3 class NetworkManagerConnectivityState(IntEnum): """NetworkManager connectivity state enum * UNKNOWN * NONE * PORTAL * LIMITED * FULL """ UNKNOWN = 0 NONE = 1 PORTAL = 2 LIMITED = 3 FULL = 4 class NetworkManagerState(IntEnum): """NetworkManager state enum * UNKNOWN * ASLEEP * DISCONNECTED * DISCONNECTING * CONNECTING * CONNECTED_LOCAL * CONNECTED_SITE * GLOBAL """ UNKNOWN = 0 ASLEEP = 10 DISCONNECTED = 20 DISCONNECTING = 30 CONNECTING = 40 CONNECTED_LOCAL = 50 CONNECTED_SITE = 60 GLOBAL = 70 python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/exceptions.py000066400000000000000000000424651442124064700275560ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from sdbus import DbusFailedError class NetworkManagerBaseError(Exception): """Base of all NetworkManager errors.""" # Errors returned from the secret-agent manager. class NmAgentManagerFailedError(DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = 'org.freedesktop.NetworkManager.AgentManager.Failed' class NmAgentManagerPermissionDeniedError( DbusFailedError, NetworkManagerBaseError): """The caller does not have permission to register a secret agent, or is trying to register the same secret agent twice.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AgentManager.PermissionDenied' ) class NmAgentManagerInvalidIdentifierError(DbusFailedError): """The identifier is not a valid secret agent identifier.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AgentManager.InvalidIdentifier' ) class NmAgentManagerNotRegisteredError( DbusFailedError, NetworkManagerBaseError): """The caller tried to unregister an agent that was not registered.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AgentManager.NotRegistered' ) class NmAgentManagerNoSecretsError( DbusFailedError, NetworkManagerBaseError): """No secret agent returned secrets for this request.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AgentManager.NoSecrets' ) class NmAgentManagerUserCanceledError( DbusFailedError, NetworkManagerBaseError): """The user canceled the secrets request.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AgentManager.UserCanceled' ) # Errors returned by Connetion objects. class NmConnectionFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.Failed' ) class NmConnectionSettingNotFoundError( DbusFailedError, NetworkManagerBaseError): """Connection object did not contain the specified Setting object.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.SettingNotFound' ) class NmConnectionPropertyNotFoundError( DbusFailedError, NetworkManagerBaseError): """Connection object did not contain the requested Setting property""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.PropertyNotFound' ) class NmConnectionPropertyNotSecretError( DbusFailedError, NetworkManagerBaseError): """An operation which requires a secret was attempted on a non-secret property.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.PropertyNotSecret' ) class NmConnectionMissingSettingError( DbusFailedError, NetworkManagerBaseError): """Connection object is missing an Setting which is required for its configuration.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.MissingSetting' ) class NmConnectionInvalidSettingError( DbusFailedError, NetworkManagerBaseError): """Connection object contains an invalid or inappropriate Setting.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.InvalidSetting' ) class NmConnectionMissingPropertyError( DbusFailedError, NetworkManagerBaseError): """Connection object is invalid because it is missing a required property.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.MissingProperty' ) class NmConnectionInvalidPropertyError( DbusFailedError, NetworkManagerBaseError): """Connection object is invalid because a property has an invalid value.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Connection.InvalidProperty' ) # Device-related errors. class NmDeviceFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.Failed' ) class NmDeviceCreationFailedError( DbusFailedError, NetworkManagerBaseError): """NetworkManager failed to create the device.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.CreationFailed' ) class NmDeviceInvalidConnectionError( DbusFailedError, NetworkManagerBaseError): """The specified connection is not valid.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.InvalidConnection' ) class NmDeviceIncompatibleConnectionError( DbusFailedError, NetworkManagerBaseError): """Specified connection is not compatible with this device.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.IncompatibleConnection' ) class NmDeviceNotActiveError( DbusFailedError, NetworkManagerBaseError): """Device does not have an active connection.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.NotActive' ) class NmDeviceNotSoftwareError( DbusFailedError, NetworkManagerBaseError): """Requested operation is only valid on software devices.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.NotSoftware' ) class NmDeviceNotAllowedError( DbusFailedError, NetworkManagerBaseError): """Requested operation is not allowed at this time.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.NotAllowed' ) class NmDeviceSpecificObjectNotFoundError( DbusFailedError, NetworkManagerBaseError): """Specific object in the activation request (eg, the AccessPoint or WimaxNsp) was not found.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.SpecificObjectNotFound' ) class NmDeviceVersionIdMismatchError( DbusFailedError, NetworkManagerBaseError): """Version id did not match.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.VersionIdMismatch' ) class NmDeviceMissingDependenciesError( DbusFailedError, NetworkManagerBaseError): """Requested operation could not be completed due to missing dependencies.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.MissingDependencies' ) class NmDeviceInvalidArgumentError( DbusFailedError, NetworkManagerBaseError): """Invalid argument. Since: 1.16.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Device.InvalidArgument' ) # Errors related to the main interface of NetworkManager. class NetworkManagerFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Failed' ) class NetworkManagerPermissionDeniedError( DbusFailedError, NetworkManagerBaseError): """Permission denied.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.PermissionDenied' ) class NetworkManagerUnknownConnectionError( DbusFailedError, NetworkManagerBaseError): """The requested connection is not known.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.UnknownConnection' ) class NetworkManagerUnknownDeviceError( DbusFailedError, NetworkManagerBaseError): """The requested device is not known.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.UnknownDevice' ) class NetworkManagerConnectionNotAvailableError( DbusFailedError, NetworkManagerBaseError): """The requested connection cannot be activated at this time.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.ConnectionNotAvailable' ) class NetworkManagerConnectionNotActiveError( DbusFailedError, NetworkManagerBaseError): """The request could not be completed because a required connection is not active.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.ConnectionNotActive' ) class NetworkManagerConnectionAlreadyActiveError( DbusFailedError, NetworkManagerBaseError): """The connection to be activated was already active on another device.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.ConnectionAlreadyActive' ) class NetworkManagerDependencyFailedError( DbusFailedError, NetworkManagerBaseError): """An activation request failed due to a dependency being unavailable.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.DependencyFailed' ) class NetworkManagerAlreadyAsleepOrAwakeError( DbusFailedError, NetworkManagerBaseError): """The manager is already in the requested sleep/wake state.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AlreadyAsleepOrAwake' ) class NetworkManagerAlreadyEnabledOrDisabledError( DbusFailedError, NetworkManagerBaseError): """The network is already enabled/disabled.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.AlreadyEnabledOrDisabled' ) class NetworkManagerUnknownLogLevelError( DbusFailedError, NetworkManagerBaseError): """Unknown log level in :py:func:`NetworkManagerInterfaceAsync.set_logging`.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.UnknownLogLevel' ) class NetworkManagerUnknownLogDomainError( DbusFailedError, NetworkManagerBaseError): """Unknown log domain in :py:func:`NetworkManagerInterfaceAsync.set_logging`.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.UnknownLogDomain' ) class NetworkManagerInvalidArgumentsError( DbusFailedError, NetworkManagerBaseError): """Invalid arguments for D-Bus request.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.InvalidArguments' ) class NetworkManagerMissingPluginError( DbusFailedError, NetworkManagerBaseError): """A plug-in was needed to complete the activation but is not available.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.MissingPlugin' ) # Errors that secret managers pass to NetworkManager class NmSecretManagerFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.Failed' ) class NmSecretManagerPermissionDeniedError( DbusFailedError, NetworkManagerBaseError): """The caller (ie, NetworkManager) is not authorized to make this request.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.PermissionDenied' ) class NmSecretManagerInvalidConnectionError( DbusFailedError, NetworkManagerBaseError): """Connection for which secrets were requested is invalid.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.InvalidConnection' ) class NmSecretManagerUserCanceledError( DbusFailedError, NetworkManagerBaseError): """Request was canceled by the user.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.UserCanceled' ) class NmSecretManagerAgentCanceledError( DbusFailedError, NetworkManagerBaseError): """Agent canceled the request because it was requested to do so by NetworkManager.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.AgentCanceled' ) class NmSecretManagerNoSecretsError( DbusFailedError, NetworkManagerBaseError): """The agent cannot find any secrets for this connection.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.SecretManager.NoSecrets' ) # Errors related to the settings/persistent # configuration interface of NetworkManager. class NmSettingsFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.Failed' ) class NmSettingsPermissionDeniedError( DbusFailedError, NetworkManagerBaseError): """Permission denied.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.PermissionDenied' ) class NmSettingsNotSupportedError( DbusFailedError, NetworkManagerBaseError): """Requested operation is not supported by any active settings backend.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.NotSupported' ) class NmSettingsInvalidConnectionError( DbusFailedError, NetworkManagerBaseError): """Connection was invalid.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.InvalidConnection' ) class NmSettingsReadOnlyConnectionError( DbusFailedError, NetworkManagerBaseError): """Attempted to modify a read-only connection.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.ReadOnlyConnection' ) class NmSettingsUuidExistsError( DbusFailedError, NetworkManagerBaseError): """Connection with that UUID already exists.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.UuidExists' ) class NmSettingsInvalidHostnameError( DbusFailedError, NetworkManagerBaseError): """Attempted to set an invalid hostname.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.InvalidHostname' ) class NmSettingsInvalidArgumentsError( DbusFailedError, NetworkManagerBaseError): """Invalid arguments.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.Settings.InvalidArguments' ) # Returned by the VPN service plugin to indicate errors. class NmVpnPluginFailedError( DbusFailedError, NetworkManagerBaseError): """Unknown or unspecified error.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.Failed' ) class NmVpnPluginStartingInProgressError( DbusFailedError, NetworkManagerBaseError): """Plugin is already starting and another connect request was received.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.StartingInProgress' ) class NmVpnPluginAlreadyStartedError( DbusFailedError, NetworkManagerBaseError): """Plugin is already connected and another connect request was received.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted' ) class NmVpnPluginStoppingInProgressError( DbusFailedError, NetworkManagerBaseError): """Plugin is already stopping and another stop request was received.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress' ) class NmVpnPluginAlreadyStoppedError( DbusFailedError, NetworkManagerBaseError): """Plugin is already stopped and another disconnect request was received.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped' ) class NmVpnPluginWrongStateError( DbusFailedError, NetworkManagerBaseError): """Operation could not be performed in this state.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.WrongState' ) class NmVpnPluginBadArgumentsError( DbusFailedError, NetworkManagerBaseError): """Operation could not be performed as the request contained malformed arguments, or arguments of unexpected type. Usually means that one of the VPN setting data items or secrets was not of the expected type (ie int, string, bool, etc). """ dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.BadArguments' ) class NmVpnPluginLaunchFailedError( DbusFailedError, NetworkManagerBaseError): """Child process failed to launch.""" dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.LaunchFailed' ) class NmVpnPluginInvalidConnectionError( DbusFailedError, NetworkManagerBaseError): """Operation could not be performed because the connection was invalid. Usually means that the connection's VPN setting was missing some required data item or secret. """ dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.InvalidConnection' ) class NmVpnPluginInteractiveNotSupportedError( DbusFailedError, NetworkManagerBaseError): """Operation could not be performed as the plugin does not support interactive operations. Interactive operations such as :py:func:`NetworkManagerVPNPluginInterfaceAsync.connect_interactive` or :py:func:`NetworkManagerVPNPluginInterfaceAsync.new_secrets`. """ dbus_error_name = ( 'org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported' ) python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/interfaces_devices.py000066400000000000000000000762301442124064700312170ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import Any, Dict, List, Tuple from sdbus import ( DbusInterfaceCommonAsync, dbus_method_async, dbus_property_async, dbus_signal_async, ) from .settings import ConnectionProfile class NetworkManagerDeviceBluetoothInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Bluetooth'): """Bluetooth device interface""" @dbus_property_async('s') def name(self) -> str: """Name of Bluetooth device""" raise NotImplementedError @dbus_property_async('u') def bt_capabilities(self) -> int: """Bluetooth device capabilities See :py:class:`BluetoothCapabilities` """ raise NotImplementedError class NetworkManagerDeviceBondInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Bond'): """Bond device interface""" @dbus_property_async('ao') def slaves(self) -> List[str]: """List of paths of enslaved devices""" raise NotImplementedError class NetworkManagerDeviceBridgeInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Bridge'): """Bridge device interface""" @dbus_property_async('ao') def slaves(self) -> List[str]: """List of paths of enslaved devices""" raise NotImplementedError class NetworkManagerDeviceGenericInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Generic'): """Generic device interface""" @dbus_property_async('s') def type_description(self) -> str: """Description of the interface type""" raise NotImplementedError class NetworkManagerDeviceIPTunnelInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.IPTunnel'): """IP tunnel device interface""" @dbus_property_async('u') def mode(self) -> int: """Tunnel mode See :py:class:`IpTunnelMode` """ raise NotImplementedError @dbus_property_async('o') def parent(self) -> str: """Object path of parent device""" raise NotImplementedError @dbus_property_async('s') def local(self) -> str: """Local endpoint""" raise NotImplementedError @dbus_property_async('s') def remote(self) -> str: """Remote endpoint""" raise NotImplementedError @dbus_property_async('y') def ttl(self) -> int: """Time to Live (TTL) 0 is special value meaning the packets inherit TTL value. """ raise NotImplementedError @dbus_property_async('y') def tos(self) -> int: """Type of service (IPv4) or traffic class (IPv6)""" raise NotImplementedError @dbus_property_async('b') def path_mtu_discovery(self) -> bool: """Whether path MTU discovery is enabled on this tunnel""" raise NotImplementedError @dbus_property_async('s') def input_key(self) -> str: """Key used for incoming packets""" raise NotImplementedError @dbus_property_async('s') def output_key(self) -> str: """Key used for outgoing packets""" raise NotImplementedError @dbus_property_async('y') def encapsulation_limit(self) -> int: """How many levels of enapsulation are permitted Only IPv6 tunnels """ raise NotImplementedError @dbus_property_async('u') def flow_label(self) -> int: """Flow label assigned to tunnel packets Only IPv6 tunnels """ raise NotImplementedError @dbus_property_async('u') def flags(self) -> int: """Tunnel flags Missing upstream documentation """ raise NotImplementedError class NetworkManagerDeviceLowpanInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Lowpan'): """6LoWPAN device interface""" @dbus_property_async('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError class NetworkManagerDeviceMacsecInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Macsec'): """MacSec device interface""" @dbus_property_async('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property_async('t') def sci(self) -> int: """Secure Channel Identifier""" raise NotImplementedError @dbus_property_async('y') def icv_length(self) -> int: """Length of Integrity Check Value""" raise NotImplementedError @dbus_property_async('t') def cipher_suite(self) -> int: """Set of cryptographic algorithms in use Not documented upstream. """ raise NotImplementedError @dbus_property_async('u') def window(self) -> int: """Size of replay window. (in number of packets)""" raise NotImplementedError @dbus_property_async('y') def encoding_sa(self) -> int: """Security Association in use""" raise NotImplementedError @dbus_property_async('s') def validation(self) -> str: """Validation mode for incoming packets * strict * check * disabled """ raise NotImplementedError @dbus_property_async('b') def encrypt(self) -> bool: """Whether encryption of transmitted frames is enabled""" raise NotImplementedError @dbus_property_async('b') def protect(self) -> bool: """Whether protection of transmitted frames is enabled""" raise NotImplementedError @dbus_property_async('b') def include_sci(self) -> bool: """Whether SCI is always included in transmitted SecTAG""" raise NotImplementedError @dbus_property_async( property_signature='b', property_name='Es', ) def end_station_enabled(self) -> bool: """Whether End Station bit is enabled in SecTAG""" raise NotImplementedError @dbus_property_async( property_signature='b', property_name='Scb', ) def scb_enabled(self) -> bool: """Whether Single Copy Broadcast is enabled in SecTAG""" raise NotImplementedError @dbus_property_async('b') def replay_protect(self) -> bool: """Whether replay protection is enabled""" raise NotImplementedError class NetworkManagerDeviceMacvlanInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Macvlan'): """MACVLAN device interface""" @dbus_property_async('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property_async('s') def mode(self) -> str: """MacVlan mode One of: * private * vepa * bridge * passthru """ raise NotImplementedError @dbus_property_async('b') def no_promisc(self) -> bool: """Whether this device is blocked from promiscuous mode""" raise NotImplementedError @dbus_property_async('b') def tap(self) -> bool: """Whether the device is macvtap""" raise NotImplementedError class NetworkManagerDeviceModemInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Modem'): """Modem device interface""" @dbus_property_async('u') def modem_capabilities(self) -> int: """Modem radio technology Switching the radio technology might require firmware reboot. See :py:class:`ModemCapabilities` """ raise NotImplementedError @dbus_property_async('u') def current_capabilities(self) -> int: """Current supported radio technologies without firmware reload""" raise NotImplementedError @dbus_property_async('s') def device_id(self) -> str: """Unique modem identifier""" raise NotImplementedError @dbus_property_async('s') def operator_code(self) -> str: """Mobile country codes (MCC) + mobile network codes (MNC) Blank if disconnected or not a 3GPP modem. """ raise NotImplementedError @dbus_property_async('s') def apn(self) -> str: """Access point name modem is connected to. Blank if disconnected. """ raise NotImplementedError class NetworkManagerDeviceOlpcMeshInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.OlpcMesh'): """OLPC Wireless Mesh device interface""" @dbus_property_async('o') def companion(self) -> str: """Path to companion device""" raise NotImplementedError @dbus_property_async('u') def active_channel(self) -> int: """Currently active channel""" raise NotImplementedError class NetworkManagerDeviceOvsBridgeInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.OvsBridge'): """Open vSwitch device interface""" @dbus_property_async('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError class NetworkManagerDeviceOvsPortInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.OvsPort'): """Open vSwitch port device interface""" @dbus_property_async('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError class NetworkManagerDeviceStatisticsInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Statistics'): """Device statistics interface""" @dbus_property_async('u') def refresh_rate_ms(self) -> int: """Refreshed rate of properties of this interface in milliseconds.""" raise NotImplementedError @dbus_property_async('t') def tx_bytes(self) -> int: """Number of transmitted bytes""" raise NotImplementedError @dbus_property_async('t') def rx_bytes(self) -> int: """Number of received bytes""" raise NotImplementedError class NetworkManagerDeviceTeamInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Team'): """Teaming device Aggregates multiple devices to a single one. Seems to be Network Manager specific type bond device. """ @dbus_property_async('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError @dbus_property_async('s') def config(self) -> str: """JSON config of the device""" raise NotImplementedError class NetworkManagerDeviceTunInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Tun'): """Userspace tunneling device interface""" @dbus_property_async('x') def owner(self) -> int: """User ID (UID) of the device owner""" raise NotImplementedError @dbus_property_async('x') def group(self) -> int: """Group ID (GID) of the device owner""" raise NotImplementedError @dbus_property_async('s') def mode(self) -> str: """Tunnel mode Either tun or tap """ raise NotImplementedError @dbus_property_async('b') def no_pi(self) -> bool: """If true no protocol info is prepended to packets""" raise NotImplementedError @dbus_property_async('b') def vnet_hdr(self) -> bool: """If true tunnel packets include virtio network header""" raise NotImplementedError @dbus_property_async('b') def multi_queue(self) -> bool: """If true callers can connect multiple times""" raise NotImplementedError class NetworkManagerDeviceVethInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Veth'): """Virtual Ethernet device interface""" @dbus_property_async('o') def peer(self) -> str: """Path to peer device""" raise NotImplementedError class NetworkManagerDeviceVlanInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Vlan'): """Virtual LAN device interface""" @dbus_property_async('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property_async('u') def vlan_id(self) -> int: """VLAN ID of this interface""" raise NotImplementedError class NetworkManagerDeviceVrfInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Vrf'): """Virtual routing and forwarding device interface""" @dbus_property_async('u') def table(self) -> int: """Routing table ID of this device""" raise NotImplementedError class NetworkManagerDeviceVxlanInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Vxlan'): """Virtual Extensible LAN device interface""" @dbus_property_async('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property_async( property_signature='u', property_name='Id' ) def vxlan_id(self) -> int: """VXLAN Network Identifier (VNI)""" raise NotImplementedError @dbus_property_async('s') def group(self) -> str: """Multicast IP group used to communicate (v4 or v6)""" raise NotImplementedError @dbus_property_async('s') def local(self) -> str: """Local IP address used to communicate""" raise NotImplementedError @dbus_property_async('y') def tos(self) -> int: """TOS field of IP packets""" raise NotImplementedError @dbus_property_async('y') def ttl(self) -> int: """TTL of IP packets""" raise NotImplementedError @dbus_property_async('b') def learning(self) -> bool: """If true VXLAN dynamically learns the remote IP address""" raise NotImplementedError @dbus_property_async('u') def ageing(self) -> int: """Interval in seconds at which kernel purges stale cached addresses""" raise NotImplementedError @dbus_property_async('u') def limit(self) -> int: """Maximum number of entries in forwarding table""" raise NotImplementedError @dbus_property_async('q') def dst_port(self) -> int: """Destination port for outgoing packets""" raise NotImplementedError @dbus_property_async('q') def src_port_min(self) -> int: """Lowest source port for outgoing packets""" raise NotImplementedError @dbus_property_async('q') def src_port_max(self) -> int: """Highest source port for outgoing packets""" raise NotImplementedError @dbus_property_async( property_signature='b', property_name='Proxy') def arp_proxy(self) -> bool: """If true ARP proxying is enabled""" raise NotImplementedError @dbus_property_async( property_signature='b', property_name='Rsc') def route_short_circuit(self) -> bool: """If true route short circuiting is enabled""" raise NotImplementedError @dbus_property_async('b') def l2miss(self) -> bool: """If true emit netlink notification on L2 switch misses""" raise NotImplementedError @dbus_property_async('b') def l3miss(self) -> bool: """If true emit netlink notification on L3 switch misses""" raise NotImplementedError class NetworkManagerDeviceWifiP2PInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.WifiP2P'): """Wi-Fi Peet to Peer device interface""" @dbus_method_async('a{sv}') async def start_find( self, options: Dict[str, Tuple[str, Any]], ) -> None: """Start find operation for Wi-Fi P2P peers Options supported: * ``timeout`` of type "i" which is a number of seconds \ for search timeout between 1-600. Default 300. """ raise NotImplementedError @dbus_method_async() async def stop_find(self) -> None: """Stop find operation""" raise NotImplementedError @dbus_property_async('ao') def peers(self) -> List[str]: """List of peer objects paths visible to this Wi-Fi device""" raise NotImplementedError @dbus_signal_async('o') def peer_added(self) -> str: """Signal when peer has been added with the new peer object path""" raise NotImplementedError @dbus_signal_async('o') def peer_removed(self) -> str: """Signal when peer has been lost with the lost peer object path""" raise NotImplementedError class NetworkManagerDeviceWiredInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Wired'): """Wired Ethernet device interface""" @dbus_property_async('s') def perm_hw_address(self) -> str: """Permanent hardware address""" raise NotImplementedError @dbus_property_async('u') def speed(self) -> int: """Design speed of the device in megabits/second""" raise NotImplementedError @dbus_property_async('as') def s390_subchannels(self) -> List[str]: """Array of IBM Z Architecture S/390 subchannels""" raise NotImplementedError class NetworkManagerDeviceWireGuardInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.WireGuard'): """WireGuard device interface""" @dbus_property_async('ay') def public_key(self) -> bytes: """Public key of the device""" raise NotImplementedError @dbus_property_async('q') def listen_port(self) -> int: """UDP listening port for incoming connections""" raise NotImplementedError @dbus_property_async('u') def fw_mark(self) -> int: """Optional packet marker to set routing policy""" raise NotImplementedError class NetworkManagerDeviceWirelessInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device.Wireless'): """Wi-Fi device interface""" @dbus_method_async( result_signature='ao', ) async def get_all_access_points( self, ) -> List[str]: """Return the list of paths to all access points visible Includes the hidden ones without SSID. """ raise NotImplementedError @dbus_method_async('a{sv}', ) async def request_scan( self, options: Dict[str, Tuple[str, Any]], ) -> None: """Request to scan for Wi-Fi access points Options: * ``ssids`` of type 'ayy' (List[bytes]) """ raise NotImplementedError @dbus_property_async('s') def perm_hw_address(self) -> str: """Permanent hardware address""" raise NotImplementedError @dbus_property_async('u') def mode(self) -> int: """Operating mode of the device See :py:class:`WiFiOperationMode` """ raise NotImplementedError @dbus_property_async('u') def bitrate(self) -> int: """Bit rate currently used in kilobits/second""" raise NotImplementedError @dbus_property_async('ao') def access_points(self) -> List[str]: """List of paths of access point currently visible""" raise NotImplementedError @dbus_property_async('o') def active_access_point(self) -> str: """Path to currently used access point""" raise NotImplementedError @dbus_property_async('u') def wireless_capabilities(self) -> int: """List of wireless device capabilities See :py:class:`WirelessCapabilities` """ raise NotImplementedError @dbus_property_async('x') def last_scan(self) -> int: """Time in CLOCK_BOOTTIME milliseconds since last scan Value -1 means never scanned. """ raise NotImplementedError @dbus_signal_async('o') def access_point_added(self) -> str: """Signal when new point is added with the path""" raise NotImplementedError @dbus_signal_async('o') def access_point_removed(self) -> str: """Signal when a point was removed with the path""" raise NotImplementedError class NetworkManagerDeviceInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Device'): """Device interface with common functionality""" @dbus_method_async( input_signature='a{sa{sv}}tu', ) async def reapply( self, connection: Dict[str, Dict[str, Tuple[str, Any]]], version_id: int, flags: int = 0, ) -> None: """Attempt to update the device configuration without deactivating :param connection: Optional connection settings to be reapplied :param version_id: Current version id of applied connection. :param flags: currently there are no flags so it should be zero """ raise NotImplementedError @dbus_method_async( input_signature='u', result_signature='a{sa{sv}}t', ) async def get_applied_connection( self, flags: int = 0, ) -> Tuple[Dict[str, Dict[str, Tuple[str, Any]]], int]: """Get the currently applied connection on the device :param flags: Currently there are no flags so this should be zero :returns: Tuple of dictionary of connection settings \ and an int version id. """ raise NotImplementedError @dbus_method_async() async def disconnect( self, ) -> None: """Disconnect device and prevent from automatically activating""" raise NotImplementedError @dbus_method_async() async def delete( self, ) -> None: """Deletes the software device. Raises an exception if the device is a hardware device. """ raise NotImplementedError @dbus_property_async('s') def udi(self) -> str: """Not stable device identifier Should not be used for tracking connection. """ raise NotImplementedError @dbus_property_async('s') def path(self) -> str: """Device path as exposed by Udev""" raise NotImplementedError @dbus_property_async('s') def interface(self) -> str: """Name of device control interface (???)""" raise NotImplementedError @dbus_property_async('s') def ip_interface(self) -> str: """Name of device data interface (???)""" raise NotImplementedError @dbus_property_async('s') def driver(self) -> str: """Driver handling device""" raise NotImplementedError @dbus_property_async('s') def driver_version(self) -> str: """Driver version""" raise NotImplementedError @dbus_property_async('s') def firmware_version(self) -> str: """Firmware version of the device""" raise NotImplementedError @dbus_property_async('u') def capabilities(self) -> int: """Capabilities of the device See :py:class:`DeviceCapabilities` """ raise NotImplementedError @dbus_property_async('u') def state(self) -> int: """Device state. See :py:class:`DeviceState` """ raise NotImplementedError @dbus_property_async('(uu)') def state_reason(self) -> Tuple[int, int]: """Current state and the reason. See :py:class:`DeviceState` and :py:class:`DeviceStateReason` """ raise NotImplementedError @dbus_property_async('o') def active_connection(self) -> str: """Path of active connection object""" raise NotImplementedError @dbus_property_async('o') def ip4_config(self) -> str: """Path of Ip4Config object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property_async('o') def dhcp4_config(self) -> str: """Path of Dhcp4 object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property_async('o') def ip6_config(self) -> str: """Path to Ip6Config object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property_async('o') def dhcp6_config(self) -> str: """Path to Dhcp6 object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property_async('b') def managed(self) -> bool: """Whether or not this device is manager by NetworkManager This setting can be written. The value is not persistent on NetworkManager restarts. """ raise NotImplementedError @dbus_property_async('b') def autoconnect(self) -> bool: """If true device is allowed to auto connect Can be written. """ raise NotImplementedError @dbus_property_async('b') def firmware_missing(self) -> bool: """If true means the device is missing firmware""" raise NotImplementedError @dbus_property_async('b') def nm_plugin_missing(self) -> bool: """If true means the plugin for NetworkManager is missing""" raise NotImplementedError @dbus_property_async('u') def device_type(self) -> int: """Device type See :py:class:`DeviceType` """ raise NotImplementedError @dbus_property_async('ao') def available_connections(self) -> List[str]: """List of object paths to connections available""" raise NotImplementedError @dbus_property_async('s') def physical_port_id(self) -> str: """Physical network port of the device""" raise NotImplementedError @dbus_property_async('u') def mtu(self) -> int: """Maximum Transmission Unit""" raise NotImplementedError @dbus_property_async('u') def metered(self) -> int: """Whether the traffic is subject to limitations See :py:class:`DeviceMetered` """ raise NotImplementedError @dbus_property_async('aa{sv}') def lldp_neighbors(self) -> List[Dict[str, Tuple[str, Any]]]: """List of LLDP neighbors Each element is the dictionary of LLDP TLV names \ to variants values. """ raise NotImplementedError @dbus_property_async('b') def real(self) -> bool: """Whether this device is exists If it does not yet exist it can be automatically created \ if one of the available connections becomes activated. """ raise NotImplementedError @dbus_property_async('u') def ip4_connectivity(self) -> int: """IPv4 connectivity state See :py:class:`ConnectivityState` """ raise NotImplementedError @dbus_property_async('u') def ip6_connectivity(self) -> int: """IPv6 connectivity state See :py:class:`ConnectivityState` """ raise NotImplementedError @dbus_property_async('u') def interface_flags(self) -> int: """Interface flags See :py:class:`DeviceInterfaceFlags` """ raise NotImplementedError @dbus_property_async('s') def hw_address(self) -> str: """Hardware address""" raise NotImplementedError @dbus_signal_async('uuu') def state_changed(self) -> Tuple[int, int, int]: """Signal when device state has changed Tuple of new state, old state and reason for new state. See :py:class:`DeviceState` and :py:class:`DeviceStateReason` """ raise NotImplementedError async def get_applied_connection_profile( self ) -> Tuple[ConnectionProfile, int]: """Get the currently applied connection on the device. .. note:: This method cannot fetch secrets. Use :py:meth:`NetworkManagerSettingsConnectionInterfaceAsync.get_profile` to acquire profile with secrets. :returns: Tuple of profile and version id. :rtype: Tuple[ConnectionProfile, int] """ connection_vardict, version_id = await self.get_applied_connection(0) return ConnectionProfile.from_dbus(connection_vardict), version_id async def reapply_profile( self, profile: ConnectionProfile, version_id: int = 0, ) -> None: """Attempts to update the configuration of a device without deactivating it. :param ConnectionProfile profile: Connection profile to update with. :param int version_id: If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via :py:meth:`get_applied_connection_profile`. """ await self.reapply(profile.to_dbus(), version_id, 0) class NetworkManagerPPPInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.PPP'): """Helper interface for PPP plugin""" @dbus_method_async( result_signature='ss', ) async def need_secrets( self, ) -> Tuple[str, str]: """Need secrets? Returns the tuple of username and password """ raise NotImplementedError @dbus_method_async('a{sv}') async def set_ip4_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv4 configuration""" raise NotImplementedError @dbus_method_async('a{sv}') async def set_ip6_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv6 configuration""" raise NotImplementedError @dbus_method_async('u') async def set_state( self, state: int, ) -> None: """Set connection state. Not documented upstream. """ raise NotImplementedError @dbus_method_async('i') async def set_ifindex( self, ifindex: int, ) -> None: """Set input device index Not documented upstream. """ raise NotImplementedError python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/interfaces_other.py000066400000000000000000001162411442124064700307130ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import Any, Dict, List, Tuple from sdbus import ( DbusInterfaceCommonAsync, dbus_method_async, dbus_property_async, dbus_signal_async, ) from .settings import ConnectionProfile from .types import NetworkManagerConnectionProperties class NetworkManagerAccessPointInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.AccessPoint'): """Interface representing Wi-Fi access point""" @dbus_property_async('u') def flags(self) -> int: """Flags describing capabilities of the point See :py:class:`AccessPointCapabilities` """ raise NotImplementedError @dbus_property_async('u') def wpa_flags(self) -> int: """Flags WPA authentication and encryption See :py:class:`WpaSecurityFlags` """ raise NotImplementedError @dbus_property_async('u') def rsn_flags(self) -> int: """Flags describing RSN (Robust Secure Network) capabilities See :py:class:`WpaSecurityFlags` """ raise NotImplementedError @dbus_property_async('ay') def ssid(self) -> bytes: """SSID of the access point. (name)""" raise NotImplementedError @dbus_property_async('u') def frequency(self) -> int: """Frequency in MHz""" raise NotImplementedError @dbus_property_async('s') def hw_address(self) -> str: """Hardware address (BSSID)""" raise NotImplementedError @dbus_property_async('u') def mode(self) -> int: """Mode of operation of access point See :py:class:`WiFiOperationMode` """ raise NotImplementedError @dbus_property_async('u') def max_bitrate(self) -> int: """Maximum bit rate of this access point. (in kilobits/second)""" raise NotImplementedError @dbus_property_async('y') def strength(self) -> int: """Current signal quality in % percent""" raise NotImplementedError @dbus_property_async('i') def last_seen(self) -> int: """Timestamp in CLOCK_BOOTTIME seconds since last seen in scan Value of -1 means that the point was never found in scans. """ raise NotImplementedError class NetworkManagerSecretAgentManagerInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.AgentManager'): """Secret Agent Manager""" @dbus_method_async('s') async def register( self, identifier: str, ) -> None: """Identifies an agent. Only one agent in each user session may use same identifier. """ raise NotImplementedError @dbus_method_async('su') async def register_with_capabilities( self, identifier: str, capabilities: int, ) -> None: """Same as register() but with agent capabilities See :py:class:`SecretAgentCapabilities` """ raise NotImplementedError @dbus_method_async() async def unregister( self, ) -> None: """Notify NetworkManager that secret agent is no longer active""" raise NotImplementedError class NetworkManagerCheckpointInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Checkpoint'): """Network Manager configuration snapshot interface""" @dbus_property_async('ao') def devices(self) -> List[str]: """List of devices which are part of this checkpoint""" raise NotImplementedError @dbus_property_async('x') def created(self) -> int: """Snapohot creation time in CLOCK_BOOTTIME milliseconds""" raise NotImplementedError @dbus_property_async('u') def rollback_timeout(self) -> int: """Automatic tollback timeout in seconds or zero""" raise NotImplementedError class NetworkManagerConnectionActiveInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Connection.Active'): """Represents an attempt to connect to network""" @dbus_property_async('o') def connection(self) -> str: """Path of connection object""" raise NotImplementedError @dbus_property_async('o') def specific_object(self) -> str: """Specific object associated with active connection""" raise NotImplementedError @dbus_property_async('s') def id(self) -> str: """Connection id""" raise NotImplementedError @dbus_property_async('s') def uuid(self) -> str: """Connection UUID""" raise NotImplementedError @dbus_property_async( property_signature='s', property_name="Type" ) def connection_type(self) -> str: """Connection type""" raise NotImplementedError @dbus_property_async('ao') def devices(self) -> List[str]: """Array of devices object paths which are part of connection""" raise NotImplementedError @dbus_property_async('u') def state(self) -> int: """Connection state See :py:class:`ConnectionState` """ raise NotImplementedError @dbus_property_async('u') def state_flags(self) -> int: """Connection state flags See :py:class:`ConnectionStateFlags` """ raise NotImplementedError @dbus_property_async('b') def default(self) -> bool: """Whether or not this connection owns default IPv4 route""" raise NotImplementedError @dbus_property_async('o') def ip4_config(self) -> str: """Object path to Ip4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property_async('o') def dhcp4_config(self) -> str: """Object path to Dhcp4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property_async('b') def default6(self) -> bool: """Whether or not this connection owns default IPv6 route""" raise NotImplementedError @dbus_property_async('o') def ip6_config(self) -> str: """Object path to Ip4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property_async('o') def dhcp6_config(self) -> str: """Object path to Dhcp6Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property_async('b') def vpn(self) -> bool: """Whether this connection is a VPN""" raise NotImplementedError @dbus_property_async('o') def master(self) -> str: """Path to master device if this connection is a slave""" raise NotImplementedError @dbus_signal_async('uu') def state_changed(self) -> Tuple[int, int]: """Signal of the new state and the reason See :py:class:`ConnectionState` and :py:class:`ConnectionStateReason` """ raise NotImplementedError class NetworkManagerVPNConnectionInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.VPN.Connection'): """VPN connection interface""" @dbus_property_async('u') def vpn_state(self) -> int: """VPN connection state See :py:class:`ConnectionState` """ raise NotImplementedError @dbus_property_async('s') def banner(self) -> str: """Banner string of VPN connection""" raise NotImplementedError @dbus_signal_async('uu') def vpn_state_changed(self) -> Tuple[int, int]: """Signal when VPN state changed Tuple of new state and reason. See :py:class:`ConnectionState` and :py:class:`ConnectionStateReason` """ raise NotImplementedError class NetworkManagerDHCP4ConfigInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.DHCP4Config'): """DHCPv4 configuration""" @dbus_property_async('a{sv}') def options(self) -> Dict[str, Tuple[str, Any]]: """Options and configurations returned by DHCPv4 server""" raise NotImplementedError class NetworkManagerDHCP6ConfigInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.DHCP6Config'): """DHCPv6 configuration""" @dbus_property_async('a{sv}') def options(self) -> Dict[str, Tuple[str, Any]]: """Options and configurations returned by DHCPv6 server""" raise NotImplementedError class NetworkManagerDnsManagerInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.DnsManager'): """DNS configuration state""" @dbus_property_async('s') def mode(self) -> str: """Current DNS processing mode""" raise NotImplementedError @dbus_property_async('s') def rc_manager(self) -> str: """Current resolv.conf management mode""" raise NotImplementedError class NetworkManagerIP4ConfigInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.IP4Config'): """IPv4 configuration state""" @dbus_property_async('aa{sv}') def address_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of IP address data objects Each dictionary includes ``'address'`` item with IP address string \ and ``'prefix'`` with an int of prefix. Some addresses may include \ additional attributes. """ raise NotImplementedError @dbus_property_async('s') def gateway(self) -> str: """Gateway in use""" raise NotImplementedError @dbus_property_async('aa{sv}') def route_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of route data objects Each dictionary includes 'dest' (IP address string), 'prefix' (int). Some routes may include 'next-hop', 'metric' and additional attributes. """ raise NotImplementedError @dbus_property_async('aa{sv}') def nameserver_data(self) -> List[Dict[str, Tuple[str, Any]]]: """List of nameserver objects Currently, each dictionary only has the 'address' value. \ (string of IP address) """ raise NotImplementedError @dbus_property_async('as') def domains(self) -> List[str]: """List of domains this address belongs to.""" raise NotImplementedError @dbus_property_async('as') def searches(self) -> List[str]: """List of DNS searches""" raise NotImplementedError @dbus_property_async('as') def dns_options(self) -> List[str]: """List of dns options""" raise NotImplementedError @dbus_property_async('i') def dns_priority(self) -> int: """Relative priority of DNS servers""" raise NotImplementedError @dbus_property_async('as') def wins_server_data(self) -> List[str]: """Windows Internet Name Service servers""" raise NotImplementedError class NetworkManagerIP6ConfigInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.IP6Config'): """IPv6 configuration""" @dbus_property_async('aa{sv}') def address_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of IP address data objects Each dictionary includes ``'address'`` item with IP address string \ and ``'prefix'`` with an int of prefix. Some addresses may include \ additional attributes. """ raise NotImplementedError @dbus_property_async('s') def gateway(self) -> str: """Gateway in use""" raise NotImplementedError @dbus_property_async('aa{sv}') def route_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of route data objects Each dictionary includes 'dest' (IP address string), 'prefix' (int). Some routes may include 'next-hop', 'metric' and additional attributes. """ raise NotImplementedError @dbus_property_async('aay') def nameservers(self) -> List[bytes]: """Nameservers in use""" raise NotImplementedError @dbus_property_async('as') def domains(self) -> List[str]: """List of domains this address belongs to.""" raise NotImplementedError @dbus_property_async('as') def searches(self) -> List[str]: """List of DNS searches""" raise NotImplementedError @dbus_property_async('as') def dns_options(self) -> List[str]: """List of dns options""" raise NotImplementedError @dbus_property_async('i') def dns_priority(self) -> int: """Relative priority of DNS servers""" raise NotImplementedError class NetworkManagerSecretAgentInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.SecretAgent'): """D-Bus interface that stores secrets such as Wi-Fi passwords""" @dbus_method_async( input_signature='a{sa{sv}}osasu', result_signature='a{sa{sv}}', ) async def get_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, setting_name: str, hints: List[str], flags: int, ) -> Dict[str, Dict[str, Tuple[str, Any]]]: """Retrieve stored secrets""" raise NotImplementedError @dbus_method_async('os') async def cancel_get_secrets( self, connection_path: str, setting_name: str, ) -> None: """Cancel pending get_secrets request""" raise NotImplementedError @dbus_method_async('a{sa{sv}}o') async def save_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, ) -> None: """Save given secrets""" raise NotImplementedError @dbus_method_async('a{sa{sv}}o') async def delete_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, ) -> None: """Delete secrets""" raise NotImplementedError class NetworkManagerSettingsConnectionInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Settings.Connection'): """Represents a single network connection""" @dbus_method_async('a{sa{sv}}') async def update( self, properties: NetworkManagerConnectionProperties, ) -> None: """Update connection settings. Replaces all previous settings and properties. """ raise NotImplementedError @dbus_method_async('a{sa{sv}}') async def update_unsaved( self, properties: NetworkManagerConnectionProperties, ) -> None: """Update connection settings but do not save to disk""" raise NotImplementedError @dbus_method_async() async def delete( self, ) -> None: """Delete connection""" raise NotImplementedError @dbus_method_async( result_signature='a{sa{sv}}', ) async def get_settings( self, ) -> NetworkManagerConnectionProperties: """Get connection settings""" raise NotImplementedError @dbus_method_async( input_signature='s', result_signature='a{sa{sv}}', ) async def get_secrets( self, setting_name: str, ) -> Dict[str, Dict[str, Tuple[str, Any]]]: """Get connection secrets""" raise NotImplementedError @dbus_method_async() async def clear_secrets( self, ) -> None: """Clear connection secrets""" raise NotImplementedError @dbus_method_async() async def save( self, ) -> None: """Save connection settings to storage""" raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}ua{sv}', result_signature='a{sv}', ) async def update2( self, settings: NetworkManagerConnectionProperties, flags: int, args: Dict[str, Tuple[str, Any]], ) -> Dict[str, Tuple[str, Any]]: """Update connection settings""" raise NotImplementedError @dbus_property_async('b') def unsaved(self) -> bool: """If true some settings are not saved to disk""" raise NotImplementedError @dbus_property_async('u') def flags(self) -> int: """Connection flags See :py:class:`ConnectionFlags` """ raise NotImplementedError @dbus_property_async('s') def filename(self) -> str: """File that stores connection settings""" raise NotImplementedError @dbus_signal_async() def updated(self) -> None: """Signal when connection updated""" raise NotImplementedError @dbus_signal_async() def removed(self) -> None: """Signal when connection is removed""" raise NotImplementedError async def update_profile( self, profile: ConnectionProfile, save_to_disk: bool = False, ) -> None: """Update connection using the profile dataclass. :param ConnectionProfile profile: Connection profile to update with. :param bool save_to_disk: Make changes permanent by saving updated values to disk. By default changes are temporary. (saved only to RAM) """ flags = 0 if save_to_disk: flags |= 0x1 else: flags |= 0x2 await self.update2(profile.to_dbus(), flags, {}) async def get_profile(self, fetch_secrets: bool = True) -> ConnectionProfile: """Get the connection settings as the profile object. :param bool fetch_secrets: Retrieve secret values. (like VPN passwords) Makes additional calls to NetworkManager. """ profile = ConnectionProfile.from_dbus(await self.get_settings()) if fetch_secrets: secrets_name_generator = profile.update_secrets_generator() try: secrets_name = next(secrets_name_generator) while True: secret_profile = ConnectionProfile.from_dbus( await self.get_secrets(secrets_name)) secrets_name = secrets_name_generator.send(secret_profile) except StopIteration: ... return profile class NetworkManagerSettingsInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.Settings'): """Global NetworkManager settings""" @dbus_method_async( result_signature='ao', ) async def list_connections( self, ) -> List[str]: """List of connection object paths""" raise NotImplementedError @dbus_method_async( input_signature='s', result_signature='o', ) async def get_connection_by_uuid( self, uuid: str, ) -> str: """Get connection path by UUID""" raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}', result_signature='o', ) async def add_connection( self, connection: NetworkManagerConnectionProperties, ) -> str: """Add connection and save to disk""" raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}', result_signature='o', ) async def add_connection_unsaved( self, connection: NetworkManagerConnectionProperties, ) -> str: """Add connection and do not save""" raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}ua{sv}', result_signature='oa{sv}', ) async def add_connection2( self, settings: NetworkManagerConnectionProperties, flags: int, args: Dict[str, Tuple[str, Any]], ) -> Tuple[str, Dict[str, Tuple[str, Any]]]: """Add connection. Flags indicate whether to save or not""" raise NotImplementedError @dbus_method_async( input_signature='as', result_signature='bas', ) async def load_connections( self, filenames: List[str], ) -> Tuple[bool, List[str]]: """Load connections from filenames :returns: Tuple of success and list of failed connection filenames. """ raise NotImplementedError @dbus_method_async( result_signature='b', ) async def reload_connections( self, ) -> bool: """Reload all connection from disk""" raise NotImplementedError @dbus_method_async('s') async def save_hostname( self, hostname: str, ) -> None: """Save hostname to persistent configuration If blank hostname is cleared. """ raise NotImplementedError @dbus_property_async('ao') def connections(self) -> List[str]: """List of paths to connection objects""" raise NotImplementedError @dbus_property_async('s') def hostname(self) -> str: """Current hostname""" raise NotImplementedError @dbus_property_async('b') def can_modify(self) -> bool: """If true adding and modifying connections is supported""" raise NotImplementedError @dbus_signal_async('o') def new_connection(self) -> str: """Signal when new connection has been added with the path""" raise NotImplementedError @dbus_signal_async('o') def connection_removed(self) -> str: """Signal when connection was removed with the path""" raise NotImplementedError async def add_connection_profile( self, profile: ConnectionProfile, save_to_disk: bool = False, ) -> Tuple[str, None]: """Add new connection using the profile object. :param ConnectionProfile profile: Connection profile to update with. :param bool save_to_disk: Make changes permanent by saving updated values to disk. By default changes are temporary. (saved only to RAM) :return: Object path of new connection and None :rtype: Tuple[str, None] """ flags = 0 if save_to_disk: flags |= 0x1 else: flags |= 0x2 return ( (await self.add_connection2(profile.to_dbus(), flags, {}))[0], None, ) class NetworkManagerVPNPluginInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.VPN.Plugin'): """Interface provided by VPN plugins""" @dbus_method_async('a{sa{sv}}') async def connect( self, connection: NetworkManagerConnectionProperties, ) -> None: """Connect to described connection Interactive secrets requests not allowed. """ raise NotImplementedError @dbus_method_async('a{sa{sv}}a{sv}') async def connect_interactive( self, connection: NetworkManagerConnectionProperties, details: Dict[str, Tuple[str, Any]], ) -> None: """Connect to described connection Interactive secrets requests allowed. (emits secrets_required signal) """ raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}', result_signature='s', ) async def need_secrets( self, settings: NetworkManagerConnectionProperties, ) -> str: """Asks plugin if connection will require secrets :return: Setting name that requires secrets """ raise NotImplementedError @dbus_method_async() async def disconnect( self, ) -> None: """Disconnect from VPN""" raise NotImplementedError @dbus_method_async('a{sv}') async def set_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set generic connection details""" raise NotImplementedError @dbus_method_async('a{sv}') async def set_ip4_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv4 settings""" raise NotImplementedError @dbus_method_async('a{sv}') async def set_ip6_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv6 settings""" raise NotImplementedError @dbus_method_async('s') async def set_failure( self, reason: str, ) -> None: """Set the plugin failure reason""" raise NotImplementedError @dbus_method_async('a{sa{sv}}') async def new_secrets( self, connection: NetworkManagerConnectionProperties, ) -> None: """Called in response to secrets_required signal param: Describes the connection including the new secrets. """ raise NotImplementedError @dbus_property_async('u') def state(self) -> int: """VPN state See :py:class:`VpnState` """ raise NotImplementedError @dbus_signal_async('u') def state_changed(self) -> int: """Signal when VPN state changed with new VPN state. See :py:class:`VpnState` """ raise NotImplementedError @dbus_signal_async('sas') def secrets_required(self) -> Tuple[str, List[str]]: """Signal when secrest are required during ongoing connection""" raise NotImplementedError @dbus_signal_async('a{sv}') def config(self) -> Dict[str, Tuple[str, Any]]: """Signal when plugin obtained generic configuration""" raise NotImplementedError @dbus_signal_async('a{sv}') def ip4_config(self) -> Dict[str, Tuple[str, Any]]: """Signal when plugin obtained IPv4 configuration""" raise NotImplementedError @dbus_signal_async('a{sv}') def ip6_config(self) -> Dict[str, Tuple[str, Any]]: """Signal when plugin obtained IPv6 configuration""" raise NotImplementedError @dbus_signal_async('s') def login_banner(self) -> str: """Signal when plugin receives login banner from VPN service""" raise NotImplementedError @dbus_signal_async('u') def failure(self) -> int: """Signal when VPN failure occurs See :py:class:`VpnFailure` """ raise NotImplementedError class NetworkManagerWifiP2PPeerInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager.WifiP2PPeer'): """Interface of a peer in Wi-Fi P2P connection""" @dbus_property_async('s') def name(self) -> str: """Device name""" raise NotImplementedError @dbus_property_async('u') def flags(self) -> int: """Flags describing capabilities of the point See :py:class:`AccessPointCapabilities` """ raise NotImplementedError @dbus_property_async('s') def manufacturer(self) -> str: """Manufacturer of the Wi-Fi P2P peer.""" raise NotImplementedError @dbus_property_async('s') def model(self) -> str: """Peer model""" raise NotImplementedError @dbus_property_async('s') def model_number(self) -> str: """Peer model number""" raise NotImplementedError @dbus_property_async('s') def serial(self) -> str: """Peer serial""" raise NotImplementedError @dbus_property_async('ay') def wfd_i_es(self) -> bytes: """Wi-Fi Display Information Elements of the peer""" raise NotImplementedError @dbus_property_async('y') def strength(self) -> int: """Current signal quality of the peer, in percent.""" raise NotImplementedError @dbus_property_async('i') def last_seen(self) -> int: """Timestamp in CLOCK_BOOTTIME seconds since last seen in scan Value of -1 means that the point was never found in scans. """ raise NotImplementedError class NetworkManagerInterfaceAsync( DbusInterfaceCommonAsync, interface_name='org.freedesktop.NetworkManager'): """Main network manager interface""" @dbus_method_async('u') async def reload( self, flags: int = 0x0, ) -> None: """Reload NetworkManager configuration Flags control what to reload: * 0x0 everything * 0x1 NetworkManager.conf * 0x2 DNS configuration * 0x4 Restart DNS plugin :param flags: Reload what? """ raise NotImplementedError @dbus_method_async( result_signature='ao', ) async def get_devices( self, ) -> List[str]: """Get list of device object paths known""" raise NotImplementedError @dbus_method_async( result_signature='ao', ) async def get_all_devices( self, ) -> List[str]: """Get list of device object paths with placeholders""" raise NotImplementedError @dbus_method_async( input_signature='s', result_signature='o', ) async def get_device_by_ip_iface( self, iface: str, ) -> str: """Get device object path by interface name""" raise NotImplementedError @dbus_method_async( input_signature='ooo', result_signature='o', ) async def activate_connection( self, connection: str = '/', device: str = '/', specific_object: str = '/', ) -> str: """Activate the connection. :return: Activated connection object path. """ raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}oo', result_signature='oo', ) async def add_and_activate_connection( self, connection: NetworkManagerConnectionProperties, device: str, specific_object: str, ) -> Tuple[str, str]: """Add a new connection and activate""" raise NotImplementedError @dbus_method_async( input_signature='a{sa{sv}}ooa{sv}', result_signature='ooa{sv}', ) async def add_and_activate_connection2( self, connection: NetworkManagerConnectionProperties, device: str, specific_object: str, options: Dict[str, Tuple[str, Any]], ) -> Tuple[str, str, Dict[str, Tuple[str, Any]]]: """Add a new connection and activate""" raise NotImplementedError @dbus_method_async('o') async def deactivate_connection( self, active_connection: str, ) -> None: """Deactivate connection by given path""" raise NotImplementedError @dbus_method_async('b') async def sleep( self, sleep: bool, ) -> None: """Intended for system suspend/resume tracking not user""" raise NotImplementedError @dbus_method_async('b') async def enable( self, enable: bool, ) -> None: """Disables all networking when set to false""" raise NotImplementedError @dbus_method_async( result_signature='a{ss}', ) async def get_permissions( self, ) -> Dict[str, str]: """Returns the permissions of caller""" raise NotImplementedError @dbus_method_async('ss') async def set_logging( self, level: str, domains: str, ) -> None: """Set logging verbosity and which operations are logged""" raise NotImplementedError @dbus_method_async( result_signature='ss', ) async def get_logging( self, ) -> Tuple[str, str]: """Get current logging settings""" raise NotImplementedError @dbus_method_async( result_signature='u', ) async def check_connectivity( self, ) -> int: """Get current connectivity state See :py:class:`NetworkManagerConnectivityState` """ raise NotImplementedError @dbus_method_async( result_signature='u', method_name='State', ) async def get_state( self, ) -> int: """Get current NetworkManager state See :py:class:`NetworkManagerState` """ raise NotImplementedError @dbus_method_async( input_signature='aouu', result_signature='o', ) async def checkpoint_create( self, devices: List[str], rollback_timeout: int, flags: int, ) -> str: """Create configuration checkpoint for given devices :return: New checkpoint object path """ raise NotImplementedError @dbus_method_async('o') async def checkpoint_destroy( self, checkpoint: str, ) -> None: """Destroy given checkpoint""" raise NotImplementedError @dbus_method_async( input_signature='o', result_signature='a{su}', ) async def checkpoint_rollback( self, checkpoint: str, ) -> Dict[str, int]: """Use given checkpoint to rollback configuration""" raise NotImplementedError @dbus_method_async('ou') async def checkpoint_adjust_rollback_timeout( self, checkpoint: str, add_timeout: int, ) -> None: """Adjust checkpoint rollback timeout""" raise NotImplementedError @dbus_property_async('ao') def devices(self) -> List[str]: """List of all current devices""" raise NotImplementedError @dbus_property_async('ao') def all_devices(self) -> List[str]: """List of all current and un-realized devices""" raise NotImplementedError @dbus_property_async('ao') def checkpoints(self) -> List[str]: """List of all checkpoint objects""" raise NotImplementedError @dbus_property_async('b') def networking_enabled(self) -> bool: """Whether networking enabled or not""" raise NotImplementedError @dbus_property_async('b') def wireless_enabled(self) -> bool: """Whether wireless enabled or not""" raise NotImplementedError @dbus_property_async('b') def wireless_hardware_enabled(self) -> bool: """Whether wireless hardware enabled with RF kill switch""" raise NotImplementedError @dbus_property_async('b') def wwan_enabled(self) -> bool: """Whether mobile broadband devices enabled""" raise NotImplementedError @dbus_property_async('b') def wwan_hardware_enabled(self) -> bool: """Whether mobile hardware devices enabled with RF kill switch""" raise NotImplementedError @dbus_property_async('b') def wimax_enabled(self) -> bool: raise NotImplementedError @dbus_property_async('ao') def active_connections(self) -> List[str]: """List of active connection paths""" raise NotImplementedError @dbus_property_async('o') def primary_connection(self) -> str: """Object path for primary connection""" raise NotImplementedError @dbus_property_async('s') def primary_connection_type(self) -> str: """Primary connection type""" raise NotImplementedError @dbus_property_async('u') def metered(self) -> int: """Primary connection metered status See :py:class:`DeviceMetered` """ raise NotImplementedError @dbus_property_async('o') def activating_connection(self) -> str: """Primary connection activating connection""" raise NotImplementedError @dbus_property_async('b') def startup(self) -> bool: """Whether NetworkManager is still activating""" raise NotImplementedError @dbus_property_async('s') def version(self) -> str: """NetworkManager version""" raise NotImplementedError @dbus_property_async('au') def capabilities(self) -> List[int]: """NetworkManager capabilities * 1 Team devices * 2 OpenVSwitch """ raise NotImplementedError @dbus_property_async('u') def state(self) -> int: """Overall state of NetworkManager See :py:class:`NetworkManagerState` """ raise NotImplementedError @dbus_property_async('u') def connectivity(self) -> int: """Overall state of connectivity See :py:class:`NetworkManagerConnectivityState` """ raise NotImplementedError @dbus_property_async('b') def connectivity_check_available(self) -> bool: raise NotImplementedError @dbus_property_async('b') def connectivity_check_enabled(self) -> bool: """Whether the connectivity checking is enabled Can be written. """ raise NotImplementedError @dbus_property_async('s') def connectivity_check_uri(self) -> str: """URI that network manager will hit to check internet connection""" raise NotImplementedError @dbus_property_async('a{sv}') def global_dns_configuration(self) -> Dict[str, Tuple[str, Any]]: """Global DNS connection settings""" raise NotImplementedError @dbus_signal_async() def check_permissions(self) -> None: """System authorization changed""" raise NotImplementedError @dbus_signal_async('u') def state_changed(self) -> int: """NetworkManager state changed See :py:class:`NetworkManagerState` """ raise NotImplementedError @dbus_signal_async('o') def device_added(self) -> str: """Signal when new device has been added with path""" raise NotImplementedError @dbus_signal_async('o') def device_removed(self) -> str: """Signal when device had been removed with path""" raise NotImplementedError async def add_and_activate_connection_profile( self, profile: ConnectionProfile, device_path: str = '/', specific_object: str = '/', ) -> Tuple[str, str]: """Adds new connection using the profile object as template. :param ConnectionProfile profile: Connection profile to update with. :param str device_path: Object path of device to be activated using the given connection :param str specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used. :return: Object path of new connection and path of active connection. :rtype: Tuple[str, str] """ return await self.add_and_activate_connection( profile.to_dbus(), device_path, specific_object, ) python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/objects.py000066400000000000000000001065671442124064700270320ustar00rootroot00000000000000 # SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import List, Optional from sdbus.sd_bus_internals import SdBus from .interfaces_devices import ( NetworkManagerDeviceBluetoothInterfaceAsync, NetworkManagerDeviceBondInterfaceAsync, NetworkManagerDeviceBridgeInterfaceAsync, NetworkManagerDeviceGenericInterfaceAsync, NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceIPTunnelInterfaceAsync, NetworkManagerDeviceMacsecInterfaceAsync, NetworkManagerDeviceMacvlanInterfaceAsync, NetworkManagerDeviceModemInterfaceAsync, NetworkManagerDeviceOlpcMeshInterfaceAsync, NetworkManagerDeviceOvsBridgeInterfaceAsync, NetworkManagerDeviceOvsPortInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceTeamInterfaceAsync, NetworkManagerDeviceTunInterfaceAsync, NetworkManagerDeviceVethInterfaceAsync, NetworkManagerDeviceVlanInterfaceAsync, NetworkManagerDeviceVrfInterfaceAsync, NetworkManagerDeviceVxlanInterfaceAsync, NetworkManagerDeviceWifiP2PInterfaceAsync, NetworkManagerDeviceWiredInterfaceAsync, NetworkManagerDeviceWireGuardInterfaceAsync, NetworkManagerDeviceWirelessInterfaceAsync, NetworkManagerPPPInterfaceAsync, ) from .interfaces_other import ( NetworkManagerAccessPointInterfaceAsync, NetworkManagerCheckpointInterfaceAsync, NetworkManagerConnectionActiveInterfaceAsync, NetworkManagerDHCP4ConfigInterfaceAsync, NetworkManagerDHCP6ConfigInterfaceAsync, NetworkManagerDnsManagerInterfaceAsync, NetworkManagerInterfaceAsync, NetworkManagerIP4ConfigInterfaceAsync, NetworkManagerIP6ConfigInterfaceAsync, NetworkManagerSecretAgentManagerInterfaceAsync, NetworkManagerSettingsConnectionInterfaceAsync, NetworkManagerSettingsInterfaceAsync, NetworkManagerVPNConnectionInterfaceAsync, NetworkManagerWifiP2PPeerInterfaceAsync, ) from .settings.profile import ConnectionProfile from .types import NetworkManagerConnectionProperties NETWORK_MANAGER_SERVICE_NAME = 'org.freedesktop.NetworkManager' class NetworkManager(NetworkManagerInterfaceAsync): """Network Manger main object Implements :py:class:`NetworkManagerInterfaceAsync` Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager', bus) class NetworkManagerAgentManager( NetworkManagerSecretAgentManagerInterfaceAsync): """NetworkManager secrets manager Implements :py:class:`NetworkManagerSecretAgentManagerInterfaceAsync`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/AgentManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/AgentManager', bus) class NetworkManagerDnsManager(NetworkManagerDnsManagerInterfaceAsync): """NetworkManager DNS manager Implements :py:class:`NetworkManagerDnsManagerInterfaceAsync`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/DnsManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/DnsManager', bus) class NetworkManagerSettings(NetworkManagerSettingsInterfaceAsync): """NetworkManager settings Implements :py:class:`NetworkManagerSettingsInterfaceAsync`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/DnsManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/Settings', bus) async def get_connections_by_id(self, connection_id: str) -> List[str]: """Helper method to get a list of connection profile paths which use the given connection identifier. :param str connection_id: The connection identifier of the connections, e.g. "Wired connection 1" :return: List of connection profile paths using the given identifier. """ connection_paths_with_matching_id = [] connection_paths: List[str] = await self.connections for connection_path in connection_paths: settings = NetworkConnectionSettings(connection_path) settings_properites = await settings.get_settings() # settings_properites["connection"]["id"][1] gives the id value: if settings_properites["connection"]["id"][1] == connection_id: connection_paths_with_matching_id.append(connection_path) return connection_paths_with_matching_id async def get_settings_by_uuid( self, connection_uuid: str ) -> NetworkManagerConnectionProperties: """Helper to get a nested settings dict of a connection profile by uuid. :param str connection_uuid: The connection uuid of the connection profile :return: Nested dictionary of all settings of the given connection profile """ connection = await self.get_connection_by_uuid(connection_uuid) connection_manager = NetworkConnectionSettings(connection) connection_settings = await connection_manager.get_settings() return connection_settings async def delete_connection_by_uuid(self, connection_uuid: str) -> None: """Helper to delete a connection profile identified by the connection uuid. :param str connection_uuid: The connection uuid of the connection profile """ conn_dbus_path = await self.get_connection_by_uuid(connection_uuid) connection_settings_manager = NetworkConnectionSettings(conn_dbus_path) await connection_settings_manager.delete() class NetworkConnectionSettings( NetworkManagerSettingsConnectionInterfaceAsync): """Setting of specific connection Implements :py:class:`NetworkManagerSettingsConnectionInterfaceAsync` """ def __init__(self, settings_path: str, bus: Optional[SdBus] = None) -> None: """ :param settings_path: D-Bus path to settings object. \ Usually obtained from \ :py:attr:`NetworkManagerDeviceInterfaceAsync.active_connection` :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, settings_path, bus) async def connection_profile(self) -> ConnectionProfile: """Return a ConnectionProfile object containing all profile settings :return: Nested dataclass containing all settings of the profile """ return ConnectionProfile.from_dbus(await self.get_settings()) class NetworkDeviceGeneric( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceGenericInterfaceAsync): """Generic device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceGenericInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWired( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceWiredInterfaceAsync): """Ethernet device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceWiredInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWireless( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceWirelessInterfaceAsync): """WiFi device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceWirelessInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBluetooth( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceBluetoothInterfaceAsync): """Bluetooth device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceBluetoothInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBond( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceBondInterfaceAsync): """Bond device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceBondInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBridge( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceBridgeInterfaceAsync): """Bridge device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceBridgeInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceIpTunnel( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceIPTunnelInterfaceAsync): """Generic device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceIPTunnelInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceMacsec( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceMacsecInterfaceAsync): """Macsec device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceMacsecInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceMacvlan( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceMacvlanInterfaceAsync): """Macvlan device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceMacvlanInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceModem( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceModemInterfaceAsync): """Generic device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceModemInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOlpcMesh( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceOlpcMeshInterfaceAsync): """OLPC wireless mesh device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceOlpcMeshInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOpenVSwitchBridge( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceOvsBridgeInterfaceAsync): """Open vSwitch bridge device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceOvsBridgeInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOpenVSwitchPort( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceOvsPortInterfaceAsync): """Open vSwitch port device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceOvsPortInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceTeam( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceTeamInterfaceAsync): """Team device (special Bond device for NetworkManager) Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceTeamInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceTun( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceTunInterfaceAsync): """TUN device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceTunInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVeth( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceVethInterfaceAsync): """Virtual Ethernet device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceVethInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVlan( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceVlanInterfaceAsync): """VLAN device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceVlanInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVrf( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceVrfInterfaceAsync): """VRF (virtual routing) device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceVrfInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVxlan( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceVxlanInterfaceAsync): """VXLAN device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceVxlanInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWifiP2P( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceWifiP2PInterfaceAsync): """Wifi Peer-to-Peer (P2P) device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceWifiP2PInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWireGuard( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerDeviceWireGuardInterfaceAsync): """Generic device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerDeviceWireGuardInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDevicePPP( NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync, NetworkManagerPPPInterfaceAsync): """PPP device Implements :py:class:`NetworkManagerDeviceInterfaceAsync`, \ :py:class:`NetworkManagerDeviceStatisticsInterfaceAsync` and \ :py:class:`NetworkManagerPPPInterfaceAsync` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class ActiveConnection(NetworkManagerConnectionActiveInterfaceAsync): """Active connection object Implements :py:class:`NetworkManagerConnectionActiveInterfaceAsync` """ def __init__(self, connection_path: str, bus: Optional[SdBus] = None) -> None: """ :param connection_path: D-Bus path to connection object. \ Obtained from \ :py:meth:`NetworkManagerDeviceInterfaceAsync.active_connection`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, connection_path, bus) class ActiveVPNConnection( ActiveConnection, NetworkManagerVPNConnectionInterfaceAsync): """Active VPN connection object Implements :py:class:`NetworkManagerConnectionActiveInterfaceAsync` and :py:class:`NetworkManagerVPNConnectionInterfaceAsync` """ ... class IPv4Config(NetworkManagerIP4ConfigInterfaceAsync): """IPv4 configuration interface Implements :py:class:`NetworkManagerIP4ConfigInterfaceAsync` """ def __init__(self, ip4_path: str, bus: Optional[SdBus] = None) -> None: """ :param ip4_path: D-Bus path to IPv4 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterfaceAsync.ip4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, ip4_path, bus) class IPv6Config(NetworkManagerIP6ConfigInterfaceAsync): """IPv6 configuration interface Implements :py:class:`NetworkManagerIP6ConfigInterfaceAsync` """ def __init__(self, ip6_path: str, bus: Optional[SdBus] = None) -> None: """ :param ip6_path: D-Bus path to IPv6 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterfaceAsync.ip4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, ip6_path, bus) class DHCPv4Config(NetworkManagerDHCP4ConfigInterfaceAsync): """DHCPv4 configuration interface Implements :py:class:`NetworkManagerDHCP4ConfigInterfaceAsync` """ def __init__(self, dhcp4_path: str, bus: Optional[SdBus] = None) -> None: """ :param dhcp4_path: D-Bus path to DHCPv4 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterfaceAsync.dhcp4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, dhcp4_path, bus) class DHCPv6Config(NetworkManagerDHCP6ConfigInterfaceAsync): """DHCPv6 configuration interface Implements :py:class:`NetworkManagerDHCP6ConfigInterfaceAsync` """ def __init__(self, dhcpv6_path: str, bus: Optional[SdBus] = None) -> None: """ :param dhcpv6_path: D-Bus path to DHCPv6 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterfaceAsync.dhcp6_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, dhcpv6_path, bus) class AccessPoint(NetworkManagerAccessPointInterfaceAsync): """Access Point (WiFi point) object Implements :py:class:`NetworkManagerAccessPointInterfaceAsync` """ def __init__(self, point_path: str, bus: Optional[SdBus] = None) -> None: """ :param point_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWirelessInterfaceAsync.access_points`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, point_path, bus) class WiFiP2PPeer(NetworkManagerWifiP2PPeerInterfaceAsync): """WiFi peer object Implements :py:class:`NetworkManagerWifiP2PPeerInterfaceAsync` """ def __init__(self, peer_path: str, bus: Optional[SdBus] = None) -> None: """ :param peer_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWifiP2PInterfaceAsync.peers`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, peer_path, bus) class ConfigCheckpoint(NetworkManagerCheckpointInterfaceAsync): """Configuration checkpoint interface Implements :py:class:`NetworkManagerCheckpointInterfaceAsync` """ def __init__(self, checkpoint_path: str, bus: Optional[SdBus] = None) -> None: """ :param checkpoint_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWifiP2PInterfaceAsync.checkpoint_create`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__() self._connect( NETWORK_MANAGER_SERVICE_NAME, checkpoint_path, bus) python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/py.typed000066400000000000000000000000001442124064700264750ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/000077500000000000000000000000001442124064700266505ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/__init__.py000066400000000000000000000070031442124064700307610ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from .profile import ConnectionProfile from .adsl import AdslSettings from .bluetooth import BluetoothSettings from .bond import BondSettings from .bond_port import BondPortSettings from .bridge import BridgeSettings from .bridge_port import BridgePortSettings from .cdma import CdmaSettings from .connection import ConnectionSettings from .dcb import DcbSettings from .dummy import DummySettings from .eapol import EapolSettings from .ethernet import EthernetSettings from .ethtool import EthtoolSettings from .generic import GenericSettings from .gsm import GsmSettings from .hostname import HostnameSettings from .infiniband import InfinibandSettings from .ip_tunnel import IpTunnelSettings from .ipv4 import Ipv4Settings from .ipv6 import Ipv6Settings from .lowpan import LowpanSettings from .macsec import MacsecSettings from .macvlan import MacvlanSettings from .match import MatchSettings from .olpc_mesh import OlpcMeshSettings from .ovs_bridge import OvsBridgeSettings from .ovs_dpdk import OvsDpdkSettings from .ovs_external_ids import OvsExternalIdsSettings from .ovs_interface import OvsInterfaceSettings from .ovs_patch import OvsPatchSettings from .ovs_port import OvsPortSettings from .ppp import PppSettings from .pppoe import PppoeSettings from .proxy import ProxySettings from .serial import SerialSettings from .sriov import SriovSettings from .tc import TcSettings from .team import TeamSettings from .team_port import TeamPortSettings from .tun import TunSettings from .user import UserSettings from .veth import VethSettings from .vlan import VlanSettings from .vpn import VpnSettings from .vrf import VrfSettings from .vxlan import VxlanSettings from .wifi_p2p import WifiP2PSettings from .wimax import WimaxSettings from .wireguard import WireguardSettings from .wireless import WirelessSettings from .wireless_security import WirelessSecuritySettings from .wpan import WpanSettings from .datatypes import ( AddressData, RouteData, LinkWatchers, Vlans, WireguardPeers, RoutingRules, Vfs, ) __all__ = ( 'ConnectionProfile', 'AdslSettings', 'BluetoothSettings', 'BondSettings', 'BondPortSettings', 'BridgeSettings', 'BridgePortSettings', 'CdmaSettings', 'ConnectionSettings', 'DcbSettings', 'DummySettings', 'EapolSettings', 'EthernetSettings', 'EthtoolSettings', 'GenericSettings', 'GsmSettings', 'HostnameSettings', 'InfinibandSettings', 'IpTunnelSettings', 'Ipv4Settings', 'Ipv6Settings', 'LowpanSettings', 'MacsecSettings', 'MacvlanSettings', 'MatchSettings', 'OlpcMeshSettings', 'OvsBridgeSettings', 'OvsDpdkSettings', 'OvsExternalIdsSettings', 'OvsInterfaceSettings', 'OvsPatchSettings', 'OvsPortSettings', 'PppSettings', 'PppoeSettings', 'ProxySettings', 'SerialSettings', 'SriovSettings', 'TcSettings', 'TeamSettings', 'TeamPortSettings', 'TunSettings', 'UserSettings', 'VethSettings', 'VlanSettings', 'VpnSettings', 'VrfSettings', 'VxlanSettings', 'WifiP2PSettings', 'WimaxSettings', 'WireguardSettings', 'WirelessSettings', 'WirelessSecuritySettings', 'WpanSettings', 'AddressData', 'RouteData', 'LinkWatchers', 'Vlans', 'WireguardPeers', 'RoutingRules', 'Vfs', ) python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/adsl.py000066400000000000000000000037471442124064700301600ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class AdslSettings(NetworkManagerSettingsMixin): """ADSL Settings""" secret_fields_names = ['password'] secret_name = 'adsl' encapsulation: Optional[str] = field( metadata={ 'dbus_name': 'encapsulation', 'dbus_type': 's', }, default=None, ) """Encapsulation of ADSL connection. Can be "vcmux" or "llc".""" password: Optional[str] = field( metadata={ 'dbus_name': 'password', 'dbus_type': 's', }, default=None, ) """Password used to authenticate with the ADSL service.""" password_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password" property.""" protocol: Optional[str] = field( metadata={ 'dbus_name': 'protocol', 'dbus_type': 's', }, default=None, ) """ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".""" username: Optional[str] = field( metadata={ 'dbus_name': 'username', 'dbus_type': 's', }, default=None, ) """Username used to authenticate with the ADSL service.""" vci: Optional[int] = field( metadata={ 'dbus_name': 'vci', 'dbus_type': 'u', }, default=None, ) """VCI of ADSL connection""" vpi: Optional[int] = field( metadata={ 'dbus_name': 'vpi', 'dbus_type': 'u', }, default=None, ) """VPI of ADSL connection""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/base.py000066400000000000000000000116241442124064700301400ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later from __future__ import annotations from dataclasses import fields from functools import lru_cache from typing import Any, ClassVar, Dict, List, Type, cast from ..types import NetworkManagerSettingsDomain class NetworkManagerSettingsMixin: secret_fields_names: ClassVar[List[str]] = [] secret_name: ClassVar[str] = '' def to_dbus(self) -> NetworkManagerSettingsDomain: """Return a dbus dictionary for NetworkManager to add/update profiles The key names provided are exactly as documented in these tables: https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html """ new_dict: NetworkManagerSettingsDomain = {} for x in fields(self): value = getattr(self, x.name) if value is None: continue if x.metadata['dbus_type'] == 'aa{sv}': packed_variant = ('aa{sv}', [x.to_dbus() for x in value]) else: packed_variant = (x.metadata['dbus_type'], value) new_dict[x.metadata['dbus_name']] = packed_variant return new_dict def to_settings_dict(self, defaults: bool = False) -> Dict[str, Any]: """Return a simple dictionary using the same key names like the dbus dict from to_dbus(), but without the dbus signatures returned by it. The key names provided are exactly as documented in these tables: https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html Contrary to dataclasses.asdict(), it provides the orignal dbus keys, e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type". In addition, it can be selected if defaults shall be omitted in output, like NetworkConnectionSettings.get_settings() omits default values: Because of this, all NetworkManager clients which read profiles have to have hard-coded knowledge of these defaults. By this omission, they are part of the stable API: They can be relied upon to never change. Omitting the defaults makes the typical output really small for review. """ new_dict = {} for x in fields(self): value = getattr(self, x.name) if value in [None, {}, []]: continue if not defaults and value == x.default: continue dbus_type = x.metadata['dbus_type'] if dbus_type == 'aa{sv}': value = [x.to_settings_dict(defaults) for x in value] elif dbus_type == 'ay' and x.name == "ssid": value = value.decode('utf8') # Make SSID JSON-serializable new_dict[x.metadata['dbus_name']] = value return new_dict @classmethod def _unpack_variant(cls, key: str, signature: str, value: Any) -> Any: if signature == 'aa{sv}': inner_class = cls.setting_name_to_inner_class(key) return [inner_class.from_dbus(x) for x in value] return value @classmethod def from_dbus( cls, dbus_dict: NetworkManagerSettingsDomain, ) -> NetworkManagerSettingsMixin: """TODO: Add proper docstring""" reverse_mapping = cls.setting_name_reverse_mapping() unvarianted_options = {} for k, v in dbus_dict.items(): try: reverse_name = reverse_mapping[k] except KeyError: continue unvarianted_options[reverse_name] = cls._unpack_variant(k, *v) return cls(**unvarianted_options) @classmethod def from_dict(cls, plain_dict: Dict[str, Any] ) -> NetworkManagerSettingsMixin: options = {} for dataclass_field in fields(cls): dbus_name = dataclass_field.metadata["dbus_name"] if dbus_name in plain_dict: value = plain_dict[dbus_name] dbus_type = dataclass_field.metadata['dbus_type'] if dbus_type == 'aa{sv}': inner_class = cls.setting_name_to_inner_class(dbus_name) value = [inner_class.from_dict(item) for item in value] elif dbus_type == 'ay' and isinstance(value, str): # If byte array(e.g. ssid) was passed as string encode it: value = value.encode('utf8') options[dataclass_field.name] = value return cls(**options) @classmethod @lru_cache(maxsize=None) def setting_name_reverse_mapping(cls) -> Dict[str, str]: return {f.metadata['dbus_name']: f.name for f in fields(cls)} @classmethod @lru_cache(maxsize=None) def setting_name_to_inner_class(cls, setting_name: str) -> Type[Any]: for x in fields(cls): if setting_name != x.metadata['dbus_name']: continue return cast(Type[Any], x.metadata['dbus_inner_class']) raise ValueError('Inner class not found') python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/bluetooth.py000066400000000000000000000016731442124064700312360ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class BluetoothSettings(NetworkManagerSettingsMixin): """Bluetooth Settings""" bdaddr: Optional[bytes] = field( metadata={ 'dbus_name': 'bdaddr', 'dbus_type': 'ay', }, default=None, ) """The Bluetooth address of the device.""" bluetooth_type: Optional[str] = field( metadata={ 'dbus_name': 'type', 'dbus_type': 's', }, default=None, ) """Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/bond.py000066400000000000000000000021451442124064700301460ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Dict, Optional from .base import NetworkManagerSettingsMixin @dataclass class BondSettings(NetworkManagerSettingsMixin): """Bonding Settings""" interface_name: Optional[str] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 's', }, default=None, ) """Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.""" options: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 'options', 'dbus_type': 'a{ss}', }, default=None, ) """Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/bond_port.py000066400000000000000000000013231442124064700312070ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class BondPortSettings(NetworkManagerSettingsMixin): """Bond Port Settings""" queue_id: Optional[int] = field( metadata={ 'dbus_name': 'queue-id', 'dbus_type': 'u', }, default=None, ) """The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/bridge.py000066400000000000000000000236051442124064700304640ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import Vlans @dataclass class BridgeSettings(NetworkManagerSettingsMixin): """Bridging Settings""" ageing_time: Optional[int] = field( metadata={ 'dbus_name': 'ageing-time', 'dbus_type': 'u', }, default=None, ) """The Ethernet MAC address aging time, in seconds.""" forward_delay: Optional[int] = field( metadata={ 'dbus_name': 'forward-delay', 'dbus_type': 'u', }, default=None, ) """The Spanning Tree Protocol (STP) forwarding delay, in seconds.""" group_address: Optional[bytes] = field( metadata={ 'dbus_name': 'group-address', 'dbus_type': 'ay', }, default=None, ) """If specified, The MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.""" group_forward_mask: Optional[int] = field( metadata={ 'dbus_name': 'group-forward-mask', 'dbus_type': 'u', }, default=None, ) """A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.""" hello_time: Optional[int] = field( metadata={ 'dbus_name': 'hello-time', 'dbus_type': 'u', }, default=None, ) """The Spanning Tree Protocol (STP) hello time, in seconds.""" interface_name: Optional[str] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 's', }, default=None, ) """Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.""" mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.""" max_age: Optional[int] = field( metadata={ 'dbus_name': 'max-age', 'dbus_type': 'u', }, default=None, ) """The Spanning Tree Protocol (STP) maximum message age, in seconds.""" multicast_hash_max: Optional[int] = field( metadata={ 'dbus_name': 'multicast-hash-max', 'dbus_type': 'u', }, default=None, ) """Set maximum size of multicast hash table (value must be a power of 2).""" multicast_last_member_count: Optional[int] = field( metadata={ 'dbus_name': 'multicast-last-member-count', 'dbus_type': 'u', }, default=None, ) """Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.""" multicast_last_member_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-last-member-interval', 'dbus_type': 't', }, default=None, ) """Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.""" multicast_membership_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-membership-interval', 'dbus_type': 't', }, default=None, ) """Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.""" multicast_querier: Optional[bool] = field( metadata={ 'dbus_name': 'multicast-querier', 'dbus_type': 'b', }, default=None, ) """Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.""" multicast_querier_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-querier-interval', 'dbus_type': 't', }, default=None, ) """If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.""" multicast_query_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-query-interval', 'dbus_type': 't', }, default=None, ) """Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.""" multicast_query_response_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-query-response-interval', 'dbus_type': 't', }, default=None, ) """Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.""" multicast_query_use_ifaddr: Optional[bool] = field( metadata={ 'dbus_name': 'multicast-query-use-ifaddr', 'dbus_type': 'b', }, default=None, ) """If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.""" multicast_router: Optional[str] = field( metadata={ 'dbus_name': 'multicast-router', 'dbus_type': 's', }, default=None, ) """Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).""" multicast_snooping: Optional[bool] = field( metadata={ 'dbus_name': 'multicast-snooping', 'dbus_type': 'b', }, default=None, ) """Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.""" multicast_startup_query_count: Optional[int] = field( metadata={ 'dbus_name': 'multicast-startup-query-count', 'dbus_type': 'u', }, default=None, ) """Set the number of IGMP queries to send during startup phase.""" multicast_startup_query_interval: Optional[int] = field( metadata={ 'dbus_name': 'multicast-startup-query-interval', 'dbus_type': 't', }, default=None, ) """Sets the time (in deciseconds) between queries sent out at startup to determine membership information.""" priority: Optional[int] = field( metadata={ 'dbus_name': 'priority', 'dbus_type': 'u', }, default=None, ) """Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.""" stp: Optional[bool] = field( metadata={ 'dbus_name': 'stp', 'dbus_type': 'b', }, default=None, ) """Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.""" vlan_default_pvid: Optional[int] = field( metadata={ 'dbus_name': 'vlan-default-pvid', 'dbus_type': 'u', }, default=None, ) """The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.""" vlan_filtering: Optional[bool] = field( metadata={ 'dbus_name': 'vlan-filtering', 'dbus_type': 'b', }, default=None, ) """Control whether VLAN filtering is enabled on the bridge.""" vlan_protocol: Optional[str] = field( metadata={ 'dbus_name': 'vlan-protocol', 'dbus_type': 's', }, default=None, ) """If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.""" vlan_stats_enabled: Optional[bool] = field( metadata={ 'dbus_name': 'vlan-stats-enabled', 'dbus_type': 'b', }, default=None, ) """Controls whether per-VLAN stats accounting is enabled.""" vlans: Optional[List[Vlans]] = field( metadata={ 'dbus_name': 'vlans', 'dbus_type': 'aa{sv}', 'dbus_inner_class': Vlans, }, default=None, ) """Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/bridge_port.py000066400000000000000000000036401442124064700315250ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import Vlans @dataclass class BridgePortSettings(NetworkManagerSettingsMixin): """Bridge Port Settings""" hairpin_mode: Optional[bool] = field( metadata={ 'dbus_name': 'hairpin-mode', 'dbus_type': 'b', }, default=None, ) """Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.""" path_cost: Optional[int] = field( metadata={ 'dbus_name': 'path-cost', 'dbus_type': 'u', }, default=None, ) """The Spanning Tree Protocol (STP) port cost for destinations via this port.""" priority: Optional[int] = field( metadata={ 'dbus_name': 'priority', 'dbus_type': 'u', }, default=None, ) """The Spanning Tree Protocol (STP) priority of this bridge port.""" vlans: Optional[List[Vlans]] = field( metadata={ 'dbus_name': 'vlans', 'dbus_type': 'aa{sv}', 'dbus_inner_class': Vlans, }, default=None, ) """Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/cdma.py000066400000000000000000000040731442124064700301320ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class CdmaSettings(NetworkManagerSettingsMixin): """CDMA-based Mobile Broadband Settings""" secret_fields_names = ['password'] secret_name = 'cdma' mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.""" number: Optional[str] = field( metadata={ 'dbus_name': 'number', 'dbus_type': 's', }, default=None, ) """The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.""" password: Optional[str] = field( metadata={ 'dbus_name': 'password', 'dbus_type': 's', }, default=None, ) """The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.""" password_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password" property.""" username: Optional[str] = field( metadata={ 'dbus_name': 'username', 'dbus_type': 's', }, default=None, ) """The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/connection.py000066400000000000000000000474641442124064700314000ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class ConnectionSettings(NetworkManagerSettingsMixin): """General Connection Profile Settings""" auth_retries: Optional[int] = field( metadata={ 'dbus_name': 'auth-retries', 'dbus_type': 'i', }, default=None, ) """The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication.""" autoconnect: Optional[bool] = field( metadata={ 'dbus_name': 'autoconnect', 'dbus_type': 'b', }, default=None, ) """Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.""" autoconnect_priority: Optional[int] = field( metadata={ 'dbus_name': 'autoconnect-priority', 'dbus_type': 'i', }, default=None, ) """The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.""" autoconnect_retries: Optional[int] = field( metadata={ 'dbus_name': 'autoconnect-retries', 'dbus_type': 'i', }, default=None, ) """The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.""" autoconnect_slaves: Optional[int] = field( metadata={ 'dbus_name': 'autoconnect-slaves', 'dbus_type': 'i', }, default=None, ) """Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.""" dns_over_tls: Optional[int] = field( metadata={ 'dbus_name': 'dns-over-tls', 'dbus_type': 'i', }, default=None, ) """Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.""" gateway_ping_timeout: Optional[int] = field( metadata={ 'dbus_name': 'gateway-ping-timeout', 'dbus_type': 'u', }, default=None, ) """If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.""" connection_id: Optional[str] = field( metadata={ 'dbus_name': 'id', 'dbus_type': 's', }, default=None, ) """A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".""" interface_name: Optional[str] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 's', }, default=None, ) """The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.""" lldp: Optional[int] = field( metadata={ 'dbus_name': 'lldp', 'dbus_type': 'i', }, default=None, ) """Whether LLDP is enabled for the connection.""" llmnr: Optional[int] = field( metadata={ 'dbus_name': 'llmnr', 'dbus_type': 'i', }, default=None, ) """Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.""" master: Optional[str] = field( metadata={ 'dbus_name': 'master', 'dbus_type': 's', }, default=None, ) """Interface name of the master device or UUID of the master connection.""" mdns: Optional[int] = field( metadata={ 'dbus_name': 'mdns', 'dbus_type': 'i', }, default=None, ) """Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.""" metered: Optional[int] = field( metadata={ 'dbus_name': 'metered', 'dbus_type': 'i', }, default=None, ) """Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.""" mptcp_flags: Optional[int] = field( metadata={ 'dbus_name': 'mptcp-flags', 'dbus_type': 'u', }, default=None, ) """Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).""" mud_url: Optional[str] = field( metadata={ 'dbus_name': 'mud-url', 'dbus_type': 's', }, default=None, ) """If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".""" multi_connect: Optional[int] = field( metadata={ 'dbus_name': 'multi-connect', 'dbus_type': 'i', }, default=None, ) """Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.""" permissions: Optional[List[str]] = field( metadata={ 'dbus_name': 'permissions', 'dbus_type': 'as', }, default=None, ) """An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.""" read_only: Optional[bool] = field( metadata={ 'dbus_name': 'read-only', 'dbus_type': 'b', }, default=None, ) """FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.""" secondaries: Optional[List[str]] = field( metadata={ 'dbus_name': 'secondaries', 'dbus_type': 'as', }, default=None, ) """List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.""" slave_type: Optional[str] = field( metadata={ 'dbus_name': 'slave-type', 'dbus_type': 's', }, default=None, ) """Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.""" stable_id: Optional[str] = field( metadata={ 'dbus_name': 'stable-id', 'dbus_type': 's', }, default=None, ) """This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen- mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.""" timestamp: Optional[int] = field( metadata={ 'dbus_name': 'timestamp', 'dbus_type': 't', }, default=None, ) """The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).""" connection_type: Optional[str] = field( metadata={ 'dbus_name': 'type', 'dbus_type': 's', }, default=None, ) """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).""" uuid: Optional[str] = field( metadata={ 'dbus_name': 'uuid', 'dbus_type': 's', }, default=None, ) """A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").""" wait_activation_delay: Optional[int] = field( metadata={ 'dbus_name': 'wait-activation-delay', 'dbus_type': 'i', }, default=None, ) """Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.""" wait_device_timeout: Optional[int] = field( metadata={ 'dbus_name': 'wait-device-timeout', 'dbus_type': 'i', }, default=None, ) """Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.""" zone: Optional[str] = field( metadata={ 'dbus_name': 'zone', 'dbus_type': 's', }, default=None, ) """The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/datatypes.py000066400000000000000000000174201442124064700312240ustar00rootroot00000000000000from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class AddressData(NetworkManagerSettingsMixin): address: str = field( metadata={'dbus_name': 'address', 'dbus_type': 's'}, ) prefix: int = field( metadata={'dbus_name': 'prefix', 'dbus_type': 'u'}, ) @dataclass class RouteData(NetworkManagerSettingsMixin): dest: str = field( metadata={'dbus_name': 'dest', 'dbus_type': 's'}, ) prefix: int = field( metadata={'dbus_name': 'prefix', 'dbus_type': 'u'}, ) next_hop: Optional[str] = field( metadata={'dbus_name': 'next-hop', 'dbus_type': 's'}, default=None, ) metric: Optional[int] = field( metadata={'dbus_name': 'metric', 'dbus_type': 'u'}, default=None, ) @dataclass class LinkWatchers(NetworkManagerSettingsMixin): """ Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details """ name: str = field( metadata={'dbus_name': 'name', 'dbus_type': 's'}, ) delay_up: Optional[int] = field( metadata={'dbus_delay-up': 'delay-up', 'dbus_type': 'u'}, default=None, ) delay_down: Optional[int] = field( metadata={'dbus_name': 'delay-down', 'dbus_type': 'u'}, default=None, ) init_wait: Optional[int] = field( metadata={'dbus_name': 'init-wait', 'dbus_type': 'u'}, default=None, ) interval: Optional[int] = field( metadata={'dbus_name': 'interval', 'dbus_type': 'u'}, default=None, ) missed_max: Optional[int] = field( metadata={'dbus_name': 'missed-max', 'dbus_type': 'u'}, default=None, ) source_host: Optional[str] = field( metadata={'dbus_name': 'source-host', 'dbus_type': 's'}, default=None, ) target_host: Optional[str] = field( metadata={'dbus_name': 'target-host', 'dbus_type': 's'}, default=None, ) validate_active: Optional[bool] = field( metadata={'dbus_name': 'validate-active', 'dbus_type': 'b'}, default=None, ) validate_inactive: Optional[bool] = field( metadata={'dbus_name': 'validate-inactive', 'dbus_type': 'b'}, default=None, ) send_alway: Optional[bool] = field( metadata={'dbus_name': 'send-alway', 'dbus_type': 'b'}, default=None, ) @dataclass class Vlans(NetworkManagerSettingsMixin): """ VLAN filtering in linux bridge connection attributes For background info, see the development of the merge: https://bugzilla.redhat.com/show_bug.cgi?id=1652910 """ vid_start: int = field( metadata={'dbus_name': 'vid-start', 'dbus_type': 'u'}, ) vid_end: int = field( metadata={'dbus_name': 'vid-end', 'dbus_type': 'u'}, ) pvid: Optional[bool] = field( metadata={'dbus_name': 'pvid', 'dbus_type': 'b'}, default=None, ) untagged: Optional[bool] = field( metadata={'dbus_name': 'untagged', 'dbus_type': 'b'}, default=None ) @dataclass class WireguardPeers(NetworkManagerSettingsMixin): public_key: Optional[str] = field( metadata={'dbus_name': 'public-key', 'dbus_type': 's'}, default=None, ) endpoint: Optional[int] = field( metadata={'dbus_name': 'endpoint', 'dbus_type': 's'}, default=None, ) allowed_ips: Optional[List[str]] = field( metadata={'dbus_name': 'allowed-ips', 'dbus_type': 'as'}, default=None, ) @dataclass class RoutingRules(NetworkManagerSettingsMixin): action: Optional[int] = field( metadata={'dbus_name': 'action', 'dbus_type': 'y'}, default=None, ) dport_end: Optional[int] = field( metadata={'dbus_name': 'dport-end', 'dbus_type': 'q'}, default=None, ) dport_start: Optional[int] = field( metadata={'dbus_name': 'dport-start', 'dbus_type': 'q'}, default=None, ) family: Optional[int] = field( metadata={'dbus_name': 'family', 'dbus_type': 'i'}, default=None, ) from_prefix: Optional[str] = field( metadata={'dbus_name': 'from', 'dbus_type': 's'}, default=None, ) from_len: Optional[int] = field( metadata={'dbus_name': 'from-len', 'dbus_type': 'y'}, default=None, ) fwmark: Optional[int] = field( metadata={'dbus_name': 'fwmark', 'dbus_type': 'u'}, default=None, ) fwmask: Optional[int] = field( metadata={'dbus_name': 'fwmask', 'dbus_type': 'u'}, default=None, ) iifname: Optional[str] = field( metadata={'dbus_name': 'iifname', 'dbus_type': 's'}, default=None, ) invert: Optional[bool] = field( metadata={'dbus_name': 'invert', 'dbus_type': 'b'}, default=None, ) ipproto: Optional[str] = field( metadata={'dbus_name': 'ipproto', 'dbus_type': 's'}, default=None, ) oifname: Optional[str] = field( metadata={'dbus_name': 'oifname', 'dbus_type': 's'}, default=None, ) priority: Optional[int] = field( metadata={'dbus_name': 'priority', 'dbus_type': 'u'}, default=None, ) sport_end: Optional[int] = field( metadata={'dbus_name': 'sport-end', 'dbus_type': 'q'}, default=None, ) sport_start: Optional[int] = field( metadata={'dbus_name': 'sport-start', 'dbus_type': 'q'}, default=None, ) supress_prefixlength: Optional[int] = field( metadata={'dbus_name': 'supress-prefixlength', 'dbus_type': 'i'}, default=None, ) table: Optional[int] = field( metadata={'dbus_name': 'table', 'dbus_type': 'u'}, default=None, ) to: Optional[str] = field( metadata={'dbus_name': 'to', 'dbus_type': 's'}, default=None, ) tos: Optional[int] = field( metadata={'dbus_name': 'tos', 'dbus_type': 'y'}, default=None, ) to_len: Optional[int] = field( metadata={'dbus_name': 'to-len', 'dbus_type': 'y'}, default=None, ) range_end: Optional[int] = field( metadata={'dbus_name': 'range-end', 'dbus_type': 'u'}, default=None, ) range_start: Optional[int] = field( metadata={'dbus_name': 'range-start', 'dbus_type': 'u'}, default=None, ) @dataclass class Vfs(NetworkManagerSettingsMixin): index: str = field( metadata={'dbus_name': 'index', 'dbus_type': 's'}, ) mac: Optional[str] = field( metadata={'dbus_name': 'mac', 'dbus_type': 's'}, default=None, ) spoof_check: Optional[str] = field( metadata={'dbus_name': 'spoof-check', 'dbus_type': 's'}, default=None, ) trust: Optional[str] = field( metadata={'dbus_name': 'trust', 'dbus_type': 's'}, default=None, ) min_tx_rate: Optional[str] = field( metadata={'dbus_name': 'min-tx-rate', 'dbus_type': 's'}, default=None, ) max_tx_rate: Optional[str] = field( metadata={'dbus_name': 'max-tx-rate', 'dbus_type': 's'}, default=None, ) vlans: Optional[str] = field( metadata={'dbus_name': 'vlans', 'dbus_type': 's'}, default=None, ) @dataclass class Qdiscs(NetworkManagerSettingsMixin): ... @dataclass class Tfilters(NetworkManagerSettingsMixin): ... python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/dcb.py000066400000000000000000000150041442124064700277520ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class DcbSettings(NetworkManagerSettingsMixin): """Data Center Bridging Settings""" app_fcoe_flags: Optional[int] = field( metadata={ 'dbus_name': 'app-fcoe-flags', 'dbus_type': 'u', }, default=None, ) """Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).""" app_fcoe_mode: Optional[str] = field( metadata={ 'dbus_name': 'app-fcoe-mode', 'dbus_type': 's', }, default=None, ) """The FCoE controller mode; either "fabric" or "vn2vn". Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".""" app_fcoe_priority: Optional[int] = field( metadata={ 'dbus_name': 'app-fcoe-priority', 'dbus_type': 'i', }, default=None, ) """The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.""" app_fip_flags: Optional[int] = field( metadata={ 'dbus_name': 'app-fip-flags', 'dbus_type': 'u', }, default=None, ) """Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).""" app_fip_priority: Optional[int] = field( metadata={ 'dbus_name': 'app-fip-priority', 'dbus_type': 'i', }, default=None, ) """The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.""" app_iscsi_flags: Optional[int] = field( metadata={ 'dbus_name': 'app-iscsi-flags', 'dbus_type': 'u', }, default=None, ) """Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).""" app_iscsi_priority: Optional[int] = field( metadata={ 'dbus_name': 'app-iscsi-priority', 'dbus_type': 'i', }, default=None, ) """The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.""" priority_bandwidth: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-bandwidth', 'dbus_type': 'au', }, default=None, ) """An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.""" priority_flow_control: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-flow-control', 'dbus_type': 'au', }, default=None, ) """An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.""" priority_flow_control_flags: Optional[int] = field( metadata={ 'dbus_name': 'priority-flow-control-flags', 'dbus_type': 'u', }, default=None, ) """Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).""" priority_group_bandwidth: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-group-bandwidth', 'dbus_type': 'au', }, default=None, ) """An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.""" priority_group_flags: Optional[int] = field( metadata={ 'dbus_name': 'priority-group-flags', 'dbus_type': 'u', }, default=None, ) """Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).""" priority_group_id: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-group-id', 'dbus_type': 'au', }, default=None, ) """An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.""" priority_strict_bandwidth: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-strict-bandwidth', 'dbus_type': 'au', }, default=None, ) """An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.""" priority_traffic_class: Optional[List[int]] = field( metadata={ 'dbus_name': 'priority-traffic-class', 'dbus_type': 'au', }, default=None, ) """An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/dummy.py000066400000000000000000000006541442124064700303620ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class DummySettings(NetworkManagerSettingsMixin): """Dummy Link Settings""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/eapol.py000066400000000000000000000607041442124064700303310ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class EapolSettings(NetworkManagerSettingsMixin): """IEEE 802.1x Authentication Settings""" secret_fields_names = ['ca_cert_password', 'client_cert_password', 'password', 'password_raw', 'phase2_ca_cert_password', 'phase2_client_cert_password', 'phase2_private_key_password', 'pin', 'private_key_password'] secret_name = '802-1x' altsubject_matches: Optional[List[str]] = field( metadata={ 'dbus_name': 'altsubject-matches', 'dbus_type': 'as', }, default=None, ) """List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.""" anonymous_identity: Optional[str] = field( metadata={ 'dbus_name': 'anonymous-identity', 'dbus_type': 's', }, default=None, ) """Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.""" auth_timeout: Optional[int] = field( metadata={ 'dbus_name': 'auth-timeout', 'dbus_type': 'i', }, default=None, ) """A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.""" ca_cert: Optional[bytes] = field( metadata={ 'dbus_name': 'ca-cert', 'dbus_type': 'ay', }, default=None, ) """Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.""" ca_cert_password: Optional[str] = field( metadata={ 'dbus_name': 'ca-cert-password', 'dbus_type': 's', }, default=None, ) """The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.""" ca_cert_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'ca-cert-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "ca-cert-password" property.""" ca_path: Optional[str] = field( metadata={ 'dbus_name': 'ca-path', 'dbus_type': 's', }, default=None, ) """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. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.""" client_cert: Optional[bytes] = field( metadata={ 'dbus_name': 'client-cert', 'dbus_type': 'ay', }, default=None, ) """Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.""" client_cert_password: Optional[str] = field( metadata={ 'dbus_name': 'client-cert-password', 'dbus_type': 's', }, default=None, ) """The password used to access the client certificate stored in "client- cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.""" client_cert_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'client-cert-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "client-cert-password" property.""" domain_match: Optional[str] = field( metadata={ 'dbus_name': 'domain-match', 'dbus_type': 's', }, default=None, ) """Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.""" domain_suffix_match: Optional[str] = field( metadata={ 'dbus_name': 'domain-suffix-match', 'dbus_type': 's', }, default=None, ) """Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.""" eap: Optional[List[str]] = field( metadata={ 'dbus_name': 'eap', 'dbus_type': 'as', }, default=None, ) """The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.""" identity: Optional[str] = field( metadata={ 'dbus_name': 'identity', 'dbus_type': 's', }, default=None, ) """Identity string for EAP authentication methods. Often the user's user or login name.""" optional: Optional[bool] = field( metadata={ 'dbus_name': 'optional', 'dbus_type': 'b', }, default=None, ) """Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.""" pac_file: Optional[str] = field( metadata={ 'dbus_name': 'pac-file', 'dbus_type': 's', }, default=None, ) """UTF-8 encoded file path containing PAC for EAP-FAST.""" password: Optional[str] = field( metadata={ 'dbus_name': 'password', 'dbus_type': 's', }, default=None, ) """UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.""" password_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password" property.""" password_raw: Optional[bytes] = field( metadata={ 'dbus_name': 'password-raw', 'dbus_type': 'ay', }, default=None, ) """Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.""" password_raw_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-raw-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password-raw" property.""" phase1_auth_flags: Optional[int] = field( metadata={ 'dbus_name': 'phase1-auth-flags', 'dbus_type': 'u', }, default=None, ) """Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.""" phase1_fast_provisioning: Optional[str] = field( metadata={ 'dbus_name': 'phase1-fast-provisioning', 'dbus_type': 's', }, default=None, ) """Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.""" phase1_peaplabel: Optional[str] = field( metadata={ 'dbus_name': 'phase1-peaplabel', 'dbus_type': 's', }, default=None, ) """Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.""" phase1_peapver: Optional[str] = field( metadata={ 'dbus_name': 'phase1-peapver', 'dbus_type': 's', }, default=None, ) """Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.""" phase2_altsubject_matches: Optional[List[str]] = field( metadata={ 'dbus_name': 'phase2-altsubject-matches', 'dbus_type': 'as', }, default=None, ) """List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.""" phase2_auth: Optional[str] = field( metadata={ 'dbus_name': 'phase2-auth', 'dbus_type': 's', }, default=None, ) """Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non- EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.""" phase2_autheap: Optional[str] = field( metadata={ 'dbus_name': 'phase2-autheap', 'dbus_type': 's', }, default=None, ) """Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.""" phase2_ca_cert: Optional[bytes] = field( metadata={ 'dbus_name': 'phase2-ca-cert', 'dbus_type': 'ay', }, default=None, ) """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"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.""" phase2_ca_cert_password: Optional[str] = field( metadata={ 'dbus_name': 'phase2-ca-cert-password', 'dbus_type': 's', }, default=None, ) """The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.""" phase2_ca_cert_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'phase2-ca-cert-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "phase2-ca-cert-password" property.""" phase2_ca_path: Optional[str] = field( metadata={ 'dbus_name': 'phase2-ca-path', 'dbus_type': 's', }, default=None, ) """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. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.""" phase2_client_cert: Optional[bytes] = field( metadata={ 'dbus_name': 'phase2-client-cert', 'dbus_type': 'ay', }, default=None, ) """Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.""" phase2_client_cert_password: Optional[str] = field( metadata={ 'dbus_name': 'phase2-client-cert-password', 'dbus_type': 's', }, default=None, ) """The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.""" phase2_client_cert_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'phase2-client-cert-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "phase2-client-cert-password" property.""" phase2_domain_match: Optional[str] = field( metadata={ 'dbus_name': 'phase2-domain-match', 'dbus_type': 's', }, default=None, ) """Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.""" phase2_domain_suffix_match: Optional[str] = field( metadata={ 'dbus_name': 'phase2-domain-suffix-match', 'dbus_type': 's', }, default=None, ) """Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.""" phase2_private_key: Optional[bytes] = field( metadata={ 'dbus_name': 'phase2-private-key', 'dbus_type': 'ay', }, default=None, ) """Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using 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 ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.""" phase2_private_key_password: Optional[str] = field( metadata={ 'dbus_name': 'phase2-private-key-password', 'dbus_type': 's', }, default=None, ) """The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.""" phase2_private_key_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'phase2-private-key-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "phase2-private-key-password" property.""" phase2_subject_match: Optional[str] = field( metadata={ 'dbus_name': 'phase2-subject-match', 'dbus_type': 's', }, default=None, ) """Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.""" pin: Optional[str] = field( metadata={ 'dbus_name': 'pin', 'dbus_type': 's', }, default=None, ) """PIN used for EAP authentication methods.""" pin_flags: Optional[int] = field( metadata={ 'dbus_name': 'pin-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "pin" property.""" private_key: Optional[bytes] = field( metadata={ 'dbus_name': 'private-key', 'dbus_type': 'ay', }, default=None, ) """Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using 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 ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.""" private_key_password: Optional[str] = field( metadata={ 'dbus_name': 'private-key-password', 'dbus_type': 's', }, default=None, ) """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.""" private_key_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'private-key-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "private-key-password" property.""" subject_match: Optional[str] = field( metadata={ 'dbus_name': 'subject-match', 'dbus_type': 's', }, default=None, ) """Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.""" system_ca_certs: Optional[bool] = field( metadata={ 'dbus_name': 'system-ca-certs', 'dbus_type': 'b', }, default=None, ) """When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca- cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ethernet.py000066400000000000000000000263201442124064700310430ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Dict, List, Optional from .base import NetworkManagerSettingsMixin @dataclass class EthernetSettings(NetworkManagerSettingsMixin): """Wired Ethernet Settings""" accept_all_mac_addresses: Optional[int] = field( metadata={ 'dbus_name': 'accept-all-mac-addresses', 'dbus_type': 'i', }, default=None, ) """When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.""" assigned_mac_address: Optional[str] = field( metadata={ 'dbus_name': 'assigned-mac-address', 'dbus_type': 's', }, default=None, ) """The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned- mac-address".""" auto_negotiate: Optional[bool] = field( metadata={ 'dbus_name': 'auto-negotiate', 'dbus_type': 'b', }, default=None, ) """When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.""" cloned_mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'cloned-mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".""" duplex: Optional[str] = field( metadata={ 'dbus_name': 'duplex', 'dbus_type': 's', }, default=None, ) """When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.""" generate_mac_address_mask: Optional[str] = field( metadata={ 'dbus_name': 'generate-mac-address-mask', 'dbus_type': 's', }, default=None, ) """With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.""" mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).""" mac_address_blacklist: Optional[List[str]] = field( metadata={ 'dbus_name': 'mac-address-blacklist', 'dbus_type': 'as', }, default=None, ) """If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.""" port: Optional[str] = field( metadata={ 'dbus_name': 'port', 'dbus_type': 's', }, default=None, ) """Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.""" s390_nettype: Optional[str] = field( metadata={ 'dbus_name': 's390-nettype', 'dbus_type': 's', }, default=None, ) """s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.""" s390_options: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 's390-options', 'dbus_type': 'a{ss}', }, default=None, ) """Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.""" s390_subchannels: Optional[List[str]] = field( metadata={ 'dbus_name': 's390-subchannels', 'dbus_type': 'as', }, default=None, ) """Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.""" speed: Optional[int] = field( metadata={ 'dbus_name': 'speed', 'dbus_type': 'u', }, default=None, ) """When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non- zero. Before specifying a speed value be sure your device supports it.""" wake_on_lan: Optional[int] = field( metadata={ 'dbus_name': 'wake-on-lan', 'dbus_type': 'u', }, default=None, ) """The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).""" wake_on_lan_password: Optional[str] = field( metadata={ 'dbus_name': 'wake-on-lan-password', 'dbus_type': 's', }, default=None, ) """If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ethtool.py000066400000000000000000000006641442124064700307060ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class EthtoolSettings(NetworkManagerSettingsMixin): """Ethtool Ethernet Settings""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/generic.py000066400000000000000000000006601442124064700306400ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class GenericSettings(NetworkManagerSettingsMixin): """Generic Link Settings""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/gsm.py000066400000000000000000000130261442124064700300120ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class GsmSettings(NetworkManagerSettingsMixin): """GSM-based Mobile Broadband Settings""" secret_fields_names = ['password', 'pin'] secret_name = 'gsm' apn: Optional[str] = field( metadata={ 'dbus_name': 'apn', 'dbus_type': 's', }, default=None, ) """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.""" auto_config: Optional[bool] = field( metadata={ 'dbus_name': 'auto-config', 'dbus_type': 'b', }, default=None, ) """When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.""" device_id: Optional[str] = field( metadata={ 'dbus_name': 'device-id', 'dbus_type': 's', }, default=None, ) """The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.""" home_only: Optional[bool] = field( metadata={ 'dbus_name': 'home-only', 'dbus_type': 'b', }, default=None, ) """When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.""" network_id: Optional[str] = field( metadata={ 'dbus_name': 'network-id', 'dbus_type': 's', }, default=None, ) """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.""" number: Optional[str] = field( metadata={ 'dbus_name': 'number', 'dbus_type': 's', }, default=None, ) """Legacy setting that used to help establishing PPP data sessions for GSM- based modems.""" password: Optional[str] = field( metadata={ 'dbus_name': 'password', 'dbus_type': 's', }, default=None, ) """The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.""" password_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password" property.""" pin: Optional[str] = field( metadata={ 'dbus_name': 'pin', 'dbus_type': 's', }, default=None, ) """If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.""" pin_flags: Optional[int] = field( metadata={ 'dbus_name': 'pin-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "pin" property.""" sim_id: Optional[str] = field( metadata={ 'dbus_name': 'sim-id', 'dbus_type': 's', }, default=None, ) """The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.""" sim_operator_id: Optional[str] = field( metadata={ 'dbus_name': 'sim-operator-id', 'dbus_type': 's', }, default=None, ) """A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.""" username: Optional[str] = field( metadata={ 'dbus_name': 'username', 'dbus_type': 's', }, default=None, ) """The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/hostname.py000066400000000000000000000057711442124064700310520ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class HostnameSettings(NetworkManagerSettingsMixin): """Hostname settings""" from_dhcp: Optional[int] = field( metadata={ 'dbus_name': 'from-dhcp', 'dbus_type': 'i', }, default=None, ) """Whether the system hostname can be determined from DHCP on this connection. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).""" from_dns_lookup: Optional[int] = field( metadata={ 'dbus_name': 'from-dns-lookup', 'dbus_type': 'i', }, default=None, ) """Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).""" only_from_default: Optional[int] = field( metadata={ 'dbus_name': 'only-from-default', 'dbus_type': 'i', }, default=None, ) """If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).""" priority: Optional[int] = field( metadata={ 'dbus_name': 'priority', 'dbus_type': 'i', }, default=None, ) """The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/infiniband.py000066400000000000000000000041061442124064700313240ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class InfinibandSettings(NetworkManagerSettingsMixin): """Infiniband Settings""" mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.""" p_key: Optional[int] = field( metadata={ 'dbus_name': 'p-key', 'dbus_type': 'i', }, default=None, ) """The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".""" transport_mode: Optional[str] = field( metadata={ 'dbus_name': 'transport-mode', 'dbus_type': 's', }, default=None, ) """The IP-over-InfiniBand transport mode. Either "datagram" or "connected".""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ip_tunnel.py000066400000000000000000000104641442124064700312240ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class IpTunnelSettings(NetworkManagerSettingsMixin): """IP Tunneling Settings""" encapsulation_limit: Optional[int] = field( metadata={ 'dbus_name': 'encapsulation-limit', 'dbus_type': 'u', }, default=None, ) """How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.""" flags: Optional[int] = field( metadata={ 'dbus_name': 'flags', 'dbus_type': 'u', }, default=None, ) """Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.""" flow_label: Optional[int] = field( metadata={ 'dbus_name': 'flow-label', 'dbus_type': 'u', }, default=None, ) """The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.""" input_key: Optional[str] = field( metadata={ 'dbus_name': 'input-key', 'dbus_type': 's', }, default=None, ) """The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.""" local: Optional[str] = field( metadata={ 'dbus_name': 'local', 'dbus_type': 's', }, default=None, ) """The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.""" mode: Optional[int] = field( metadata={ 'dbus_name': 'mode', 'dbus_type': 'u', }, default=None, ) """The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.""" output_key: Optional[str] = field( metadata={ 'dbus_name': 'output-key', 'dbus_type': 's', }, default=None, ) """The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.""" path_mtu_discovery: Optional[bool] = field( metadata={ 'dbus_name': 'path-mtu-discovery', 'dbus_type': 'b', }, default=None, ) """Whether to enable Path MTU Discovery on this tunnel.""" remote: Optional[str] = field( metadata={ 'dbus_name': 'remote', 'dbus_type': 's', }, default=None, ) """The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.""" tos: Optional[int] = field( metadata={ 'dbus_name': 'tos', 'dbus_type': 'u', }, default=None, ) """The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.""" ttl: Optional[int] = field( metadata={ 'dbus_name': 'ttl', 'dbus_type': 'u', }, default=None, ) """The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ipv4.py000066400000000000000000000557111442124064700301150ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import AddressData, RouteData, RoutingRules @dataclass class Ipv4Settings(NetworkManagerSettingsMixin): """IPv4 Settings""" address_data: Optional[List[AddressData]] = field( metadata={ 'dbus_name': 'address-data', 'dbus_type': 'aa{sv}', 'dbus_inner_class': AddressData, }, default=None, ) """Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.""" addresses: Optional[List[List[int]]] = field( metadata={ 'dbus_name': 'addresses', 'dbus_type': 'aau', }, default=None, ) """Array of IP addresses.""" dad_timeout: Optional[int] = field( metadata={ 'dbus_name': 'dad-timeout', 'dbus_type': 'i', }, default=None, ) """Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.""" dhcp_client_id: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-client-id', 'dbus_type': 's', }, default=None, ) """A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware- address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.""" dhcp_fqdn: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-fqdn', 'dbus_type': 's', }, default=None, ) """If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.""" dhcp_hostname: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-hostname', 'dbus_type': 's', }, default=None, ) """If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.""" dhcp_hostname_flags: Optional[int] = field( metadata={ 'dbus_name': 'dhcp-hostname-flags', 'dbus_type': 'u', }, default=None, ) """Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.""" dhcp_iaid: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-iaid', 'dbus_type': 's', }, default=None, ) """A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.""" dhcp_reject_servers: Optional[List[str]] = field( metadata={ 'dbus_name': 'dhcp-reject-servers', 'dbus_type': 'as', }, default=None, ) """Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.""" dhcp_send_hostname: Optional[bool] = field( metadata={ 'dbus_name': 'dhcp-send-hostname', 'dbus_type': 'b', }, default=None, ) """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 NULL and this property is TRUE, the current persistent hostname of the computer is sent.""" dhcp_timeout: Optional[int] = field( metadata={ 'dbus_name': 'dhcp-timeout', 'dbus_type': 'i', }, default=None, ) """A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.""" dhcp_vendor_class_identifier: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-vendor-class-identifier', 'dbus_type': 's', }, default=None, ) """The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. Since 1.28""" dns: Optional[List[int]] = field( metadata={ 'dbus_name': 'dns', 'dbus_type': 'au', }, default=None, ) """Array of IP addresses of DNS servers. For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.""" dns_data: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-data', 'dbus_type': 'as', }, default=None, ) """Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.""" dns_options: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-options', 'dbus_type': 'as', }, default=None, ) """Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single- request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.""" dns_priority: Optional[int] = field( metadata={ 'dbus_name': 'dns-priority', 'dbus_type': 'i', }, default=None, ) """DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.""" dns_search: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-search', 'dbus_type': 'as', }, default=None, ) """List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).""" gateway: Optional[str] = field( metadata={ 'dbus_name': 'gateway', 'dbus_type': 's', }, default=None, ) """The gateway associated with this configuration. This is only meaningful if "addresses" is also set. Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".""" ignore_auto_dns: Optional[bool] = field( metadata={ 'dbus_name': 'ignore-auto-dns', 'dbus_type': 'b', }, default=None, ) """When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.""" ignore_auto_routes: Optional[bool] = field( metadata={ 'dbus_name': 'ignore-auto-routes', 'dbus_type': 'b', }, default=None, ) """When "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.""" link_local: Optional[int] = field( metadata={ 'dbus_name': 'link-local', 'dbus_type': 'i', }, default=None, ) """Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default". Since 1.40""" may_fail: Optional[bool] = field( metadata={ 'dbus_name': 'may-fail', 'dbus_type': 'b', }, default=None, ) """If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.""" method: Optional[str] = field( metadata={ 'dbus_name': 'method', 'dbus_type': 's', }, default=None, ) """IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.""" never_default: Optional[bool] = field( metadata={ 'dbus_name': 'never-default', 'dbus_type': 'b', }, default=None, ) """If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.""" required_timeout: Optional[int] = field( metadata={ 'dbus_name': 'required-timeout', 'dbus_type': 'i', }, default=None, ) """The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).""" route_data: Optional[List[RouteData]] = field( metadata={ 'dbus_name': 'route-data', 'dbus_type': 'aa{sv}', 'dbus_inner_class': RouteData, }, default=None, ) """Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.""" route_metric: Optional[int] = field( metadata={ 'dbus_name': 'route-metric', 'dbus_type': 'x', }, default=None, ) """The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.""" route_table: Optional[int] = field( metadata={ 'dbus_name': 'route-table', 'dbus_type': 'u', }, default=None, ) """Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.""" routes: Optional[List[List[int]]] = field( metadata={ 'dbus_name': 'routes', 'dbus_type': 'aau', }, default=None, ) """Array of IP routes.""" routing_rules: Optional[List[RoutingRules]] = field( metadata={ 'dbus_name': 'routing-rules', 'dbus_type': 'aa{sv}', 'dbus_inner_class': RoutingRules, }, default=None, ) """Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ipv6.py000066400000000000000000000625511442124064700301170ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import AddressData, RouteData, RoutingRules @dataclass class Ipv6Settings(NetworkManagerSettingsMixin): """IPv6 Settings""" addr_gen_mode: Optional[int] = field( metadata={ 'dbus_name': 'addr-gen-mode', 'dbus_type': 'i', }, default=None, ) """Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr- gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.""" address_data: Optional[List[AddressData]] = field( metadata={ 'dbus_name': 'address-data', 'dbus_type': 'aa{sv}', 'dbus_inner_class': AddressData, }, default=None, ) """Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.""" dad_timeout: Optional[int] = field( metadata={ 'dbus_name': 'dad-timeout', 'dbus_type': 'i', }, default=None, ) """Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.""" dhcp_duid: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-duid', 'dbus_type': 's', }, default=None, ) """A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link- layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.""" dhcp_hostname: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-hostname', 'dbus_type': 's', }, default=None, ) """If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.""" dhcp_hostname_flags: Optional[int] = field( metadata={ 'dbus_name': 'dhcp-hostname-flags', 'dbus_type': 'u', }, default=None, ) """Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.""" dhcp_iaid: Optional[str] = field( metadata={ 'dbus_name': 'dhcp-iaid', 'dbus_type': 's', }, default=None, ) """A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.""" dhcp_reject_servers: Optional[List[str]] = field( metadata={ 'dbus_name': 'dhcp-reject-servers', 'dbus_type': 'as', }, default=None, ) """Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.""" dhcp_send_hostname: Optional[bool] = field( metadata={ 'dbus_name': 'dhcp-send-hostname', 'dbus_type': 'b', }, default=None, ) """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 NULL and this property is TRUE, the current persistent hostname of the computer is sent.""" dhcp_timeout: Optional[int] = field( metadata={ 'dbus_name': 'dhcp-timeout', 'dbus_type': 'i', }, default=None, ) """A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.""" dns: Optional[List[bytes]] = field( metadata={ 'dbus_name': 'dns', 'dbus_type': 'aay', }, default=None, ) """Array of IP addresses of DNS servers. For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.""" dns_data: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-data', 'dbus_type': 'as', }, default=None, ) """Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.""" dns_options: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-options', 'dbus_type': 'as', }, default=None, ) """Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single- request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.""" dns_priority: Optional[int] = field( metadata={ 'dbus_name': 'dns-priority', 'dbus_type': 'i', }, default=None, ) """DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.""" dns_search: Optional[List[str]] = field( metadata={ 'dbus_name': 'dns-search', 'dbus_type': 'as', }, default=None, ) """List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).""" gateway: Optional[str] = field( metadata={ 'dbus_name': 'gateway', 'dbus_type': 's', }, default=None, ) """The gateway associated with this configuration. This is only meaningful if "addresses" is also set. Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".""" ignore_auto_dns: Optional[bool] = field( metadata={ 'dbus_name': 'ignore-auto-dns', 'dbus_type': 'b', }, default=None, ) """When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.""" ignore_auto_routes: Optional[bool] = field( metadata={ 'dbus_name': 'ignore-auto-routes', 'dbus_type': 'b', }, default=None, ) """When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.""" ip6_privacy: Optional[int] = field( metadata={ 'dbus_name': 'ip6-privacy', 'dbus_type': 'i', }, default=None, ) """Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable- privacy" setting as another way of avoiding host tracking with IPv6 addresses.""" may_fail: Optional[bool] = field( metadata={ 'dbus_name': 'may-fail', 'dbus_type': 'b', }, default=None, ) """If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.""" method: Optional[str] = field( metadata={ 'dbus_name': 'method', 'dbus_type': 's', }, default=None, ) """IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.""" never_default: Optional[bool] = field( metadata={ 'dbus_name': 'never-default', 'dbus_type': 'b', }, default=None, ) """If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.""" ra_timeout: Optional[int] = field( metadata={ 'dbus_name': 'ra-timeout', 'dbus_type': 'i', }, default=None, ) """A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. Set to 2147483647 (MAXINT32) for infinity.""" required_timeout: Optional[int] = field( metadata={ 'dbus_name': 'required-timeout', 'dbus_type': 'i', }, default=None, ) """The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).""" route_data: Optional[List[RouteData]] = field( metadata={ 'dbus_name': 'route-data', 'dbus_type': 'aa{sv}', 'dbus_inner_class': RouteData, }, default=None, ) """Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.""" route_metric: Optional[int] = field( metadata={ 'dbus_name': 'route-metric', 'dbus_type': 'x', }, default=None, ) """The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.""" route_table: Optional[int] = field( metadata={ 'dbus_name': 'route-table', 'dbus_type': 'u', }, default=None, ) """Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.""" routing_rules: Optional[List[RoutingRules]] = field( metadata={ 'dbus_name': 'routing-rules', 'dbus_type': 'aa{sv}', 'dbus_inner_class': RoutingRules, }, default=None, ) """Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).""" token: Optional[str] = field( metadata={ 'dbus_name': 'token', 'dbus_type': 's', }, default=None, ) """Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen- mode.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/lowpan.py000066400000000000000000000013231442124064700305210ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class LowpanSettings(NetworkManagerSettingsMixin): """6LoWPAN Settings""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/macsec.py000066400000000000000000000055011442124064700304560ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class MacsecSettings(NetworkManagerSettingsMixin): """MACSec Settings""" secret_fields_names = ['mka_cak'] secret_name = 'macsec' encrypt: Optional[bool] = field( metadata={ 'dbus_name': 'encrypt', 'dbus_type': 'b', }, default=None, ) """Whether the transmitted traffic must be encrypted.""" mka_cak: Optional[str] = field( metadata={ 'dbus_name': 'mka-cak', 'dbus_type': 's', }, default=None, ) """The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.""" mka_cak_flags: Optional[int] = field( metadata={ 'dbus_name': 'mka-cak-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "mka-cak" property.""" mka_ckn: Optional[str] = field( metadata={ 'dbus_name': 'mka-ckn', 'dbus_type': 's', }, default=None, ) """The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.""" mode: Optional[int] = field( metadata={ 'dbus_name': 'mode', 'dbus_type': 'i', }, default=None, ) """Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.""" port: Optional[int] = field( metadata={ 'dbus_name': 'port', 'dbus_type': 'i', }, default=None, ) """The port component of the SCI (Secure Channel Identifier), between 1 and 65534.""" send_sci: Optional[bool] = field( metadata={ 'dbus_name': 'send-sci', 'dbus_type': 'b', }, default=None, ) """Specifies whether the SCI (Secure Channel Identifier) is included in every packet.""" validation: Optional[int] = field( metadata={ 'dbus_name': 'validation', 'dbus_type': 'i', }, default=None, ) """Specifies the validation mode for incoming frames.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/macvlan.py000066400000000000000000000030551442124064700306460ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class MacvlanSettings(NetworkManagerSettingsMixin): """MAC VLAN Settings""" mode: Optional[int] = field( metadata={ 'dbus_name': 'mode', 'dbus_type': 'u', }, default=None, ) """The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.""" promiscuous: Optional[bool] = field( metadata={ 'dbus_name': 'promiscuous', 'dbus_type': 'b', }, default=None, ) """Whether the interface should be put in promiscuous mode.""" tap: Optional[bool] = field( metadata={ 'dbus_name': 'tap', 'dbus_type': 'b', }, default=None, ) """Whether the interface should be a MACVTAP.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/match.py000066400000000000000000000076311442124064700303250ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class MatchSettings(NetworkManagerSettingsMixin): """Match settings""" driver: Optional[List[str]] = field( metadata={ 'dbus_name': 'driver', 'dbus_type': 'as', }, default=None, ) """A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.""" interface_name: Optional[List[str]] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 'as', }, default=None, ) """A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".""" kernel_command_line: Optional[List[str]] = field( metadata={ 'dbus_name': 'kernel-command-line', 'dbus_type': 'as', }, default=None, ) """A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.""" path: Optional[List[str]] = field( metadata={ 'dbus_name': 'path', 'dbus_type': 'as', }, default=None, ) """A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/olpc_mesh.py000066400000000000000000000024201442124064700311710ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OlpcMeshSettings(NetworkManagerSettingsMixin): """OLPC Wireless Mesh Settings""" channel: Optional[int] = field( metadata={ 'dbus_name': 'channel', 'dbus_type': 'u', }, default=None, ) """Channel on which the mesh network to join is located.""" dhcp_anycast_address: Optional[bytes] = field( metadata={ 'dbus_name': 'dhcp-anycast-address', 'dbus_type': 'ay', }, default=None, ) """Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin.""" ssid: Optional[bytes] = field( metadata={ 'dbus_name': 'ssid', 'dbus_type': 'ay', }, default=None, ) """SSID of the mesh network to join.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_bridge.py000066400000000000000000000030211442124064700313410ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsBridgeSettings(NetworkManagerSettingsMixin): """OvsBridge Link Settings""" datapath_type: Optional[str] = field( metadata={ 'dbus_name': 'datapath-type', 'dbus_type': 's', }, default=None, ) """The data path type. One of "system", "netdev" or empty.""" fail_mode: Optional[str] = field( metadata={ 'dbus_name': 'fail-mode', 'dbus_type': 's', }, default=None, ) """The bridge failure mode. One of "secure", "standalone" or empty.""" mcast_snooping_enable: Optional[bool] = field( metadata={ 'dbus_name': 'mcast-snooping-enable', 'dbus_type': 'b', }, default=None, ) """Enable or disable multicast snooping.""" rstp_enable: Optional[bool] = field( metadata={ 'dbus_name': 'rstp-enable', 'dbus_type': 'b', }, default=None, ) """Enable or disable RSTP.""" stp_enable: Optional[bool] = field( metadata={ 'dbus_name': 'stp-enable', 'dbus_type': 'b', }, default=None, ) """Enable or disable STP.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_dpdk.py000066400000000000000000000017001442124064700310310ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsDpdkSettings(NetworkManagerSettingsMixin): """OvsDpdk Link Settings""" devargs: Optional[str] = field( metadata={ 'dbus_name': 'devargs', 'dbus_type': 's', }, default=None, ) """Open vSwitch DPDK device arguments.""" n_rxq: Optional[int] = field( metadata={ 'dbus_name': 'n-rxq', 'dbus_type': 'u', }, default=None, ) """Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_external_ids.py000066400000000000000000000012561442124064700325760ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Dict, Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsExternalIdsSettings(NetworkManagerSettingsMixin): """OVS External IDs Settings""" data: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 'data', 'dbus_type': 'a{ss}', }, default=None, ) """A dictionary of key/value pairs with exernal-ids for OVS.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_interface.py000066400000000000000000000023321442124064700320510ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsInterfaceSettings(NetworkManagerSettingsMixin): """Open vSwitch Interface Settings""" ofport_request: Optional[int] = field( metadata={ 'dbus_name': 'ofport-request', 'dbus_type': 'u', }, default=None, ) """Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.""" ovs_interface_type: Optional[str] = field( metadata={ 'dbus_name': 'type', 'dbus_type': 's', }, default=None, ) """The interface type. Either "internal", "system", "patch", "dpdk", or empty.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_patch.py000066400000000000000000000013411442124064700312070ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsPatchSettings(NetworkManagerSettingsMixin): """OvsPatch Link Settings""" peer: Optional[str] = field( metadata={ 'dbus_name': 'peer', 'dbus_type': 's', }, default=None, ) """Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ovs_port.py000066400000000000000000000034631442124064700311030ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class OvsPortSettings(NetworkManagerSettingsMixin): """OvsPort Link Settings""" bond_downdelay: Optional[int] = field( metadata={ 'dbus_name': 'bond-downdelay', 'dbus_type': 'u', }, default=None, ) """The time port must be inactive in order to be considered down.""" bond_mode: Optional[str] = field( metadata={ 'dbus_name': 'bond-mode', 'dbus_type': 's', }, default=None, ) """Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".""" bond_updelay: Optional[int] = field( metadata={ 'dbus_name': 'bond-updelay', 'dbus_type': 'u', }, default=None, ) """The time port must be active before it starts forwarding traffic.""" lacp: Optional[str] = field( metadata={ 'dbus_name': 'lacp', 'dbus_type': 's', }, default=None, ) """LACP mode. One of "active", "off", or "passive".""" tag: Optional[int] = field( metadata={ 'dbus_name': 'tag', 'dbus_type': 'u', }, default=None, ) """The VLAN tag in the range 0-4095.""" vlan_mode: Optional[str] = field( metadata={ 'dbus_name': 'vlan-mode', 'dbus_type': 's', }, default=None, ) """The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/ppp.py000066400000000000000000000134641442124064700300310ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class PppSettings(NetworkManagerSettingsMixin): """Point-to-Point Protocol Settings""" baud: Optional[int] = field( metadata={ 'dbus_name': 'baud', 'dbus_type': 'u', }, default=None, ) """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.""" crtscts: Optional[bool] = field( metadata={ 'dbus_name': 'crtscts', 'dbus_type': 'b', }, default=None, ) """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.""" lcp_echo_failure: Optional[int] = field( metadata={ 'dbus_name': 'lcp-echo-failure', 'dbus_type': 'u', }, default=None, ) """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.""" lcp_echo_interval: Optional[int] = field( metadata={ 'dbus_name': 'lcp-echo-interval', 'dbus_type': 'u', }, default=None, ) """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.""" mppe_stateful: Optional[bool] = field( metadata={ 'dbus_name': 'mppe-stateful', 'dbus_type': 'b', }, default=None, ) """If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.""" mru: Optional[int] = field( metadata={ 'dbus_name': 'mru', 'dbus_type': 'u', }, default=None, ) """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.""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, instruct pppd to send packets no larger than the specified size.""" no_vj_comp: Optional[bool] = field( metadata={ 'dbus_name': 'no-vj-comp', 'dbus_type': 'b', }, default=None, ) """If TRUE, Van Jacobsen TCP header compression will not be requested.""" noauth: Optional[bool] = field( metadata={ 'dbus_name': 'noauth', 'dbus_type': 'b', }, default=None, ) """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.""" nobsdcomp: Optional[bool] = field( metadata={ 'dbus_name': 'nobsdcomp', 'dbus_type': 'b', }, default=None, ) """If TRUE, BSD compression will not be requested.""" nodeflate: Optional[bool] = field( metadata={ 'dbus_name': 'nodeflate', 'dbus_type': 'b', }, default=None, ) """If TRUE, "deflate" compression will not be requested.""" refuse_chap: Optional[bool] = field( metadata={ 'dbus_name': 'refuse-chap', 'dbus_type': 'b', }, default=None, ) """If TRUE, the CHAP authentication method will not be used.""" refuse_eap: Optional[bool] = field( metadata={ 'dbus_name': 'refuse-eap', 'dbus_type': 'b', }, default=None, ) """If TRUE, the EAP authentication method will not be used.""" refuse_mschap: Optional[bool] = field( metadata={ 'dbus_name': 'refuse-mschap', 'dbus_type': 'b', }, default=None, ) """If TRUE, the MSCHAP authentication method will not be used.""" refuse_mschapv2: Optional[bool] = field( metadata={ 'dbus_name': 'refuse-mschapv2', 'dbus_type': 'b', }, default=None, ) """If TRUE, the MSCHAPv2 authentication method will not be used.""" refuse_pap: Optional[bool] = field( metadata={ 'dbus_name': 'refuse-pap', 'dbus_type': 'b', }, default=None, ) """If TRUE, the PAP authentication method will not be used.""" require_mppe: Optional[bool] = field( metadata={ 'dbus_name': 'require-mppe', 'dbus_type': 'b', }, default=None, ) """If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.""" require_mppe_128: Optional[bool] = field( metadata={ 'dbus_name': 'require-mppe-128', 'dbus_type': 'b', }, default=None, ) """If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) 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.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/pppoe.py000066400000000000000000000040211442124064700303420ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class PppoeSettings(NetworkManagerSettingsMixin): """PPP-over-Ethernet Settings""" secret_fields_names = ['password'] secret_name = 'pppoe' parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.""" password: Optional[str] = field( metadata={ 'dbus_name': 'password', 'dbus_type': 's', }, default=None, ) """Password used to authenticate with the PPPoE service.""" password_flags: Optional[int] = field( metadata={ 'dbus_name': 'password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "password" property.""" service: Optional[str] = field( metadata={ 'dbus_name': 'service', 'dbus_type': 's', }, default=None, ) """If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.""" username: Optional[str] = field( metadata={ 'dbus_name': 'username', 'dbus_type': 's', }, default=None, ) """Username used to authenticate with the PPPoE service.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/profile.py000066400000000000000000000430031442124064700306620ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field, fields from typing import Any, Dict, Generator, Optional from .base import NetworkManagerSettingsMixin from .adsl import AdslSettings from .bluetooth import BluetoothSettings from .bond import BondSettings from .bond_port import BondPortSettings from .bridge import BridgeSettings from .bridge_port import BridgePortSettings from .cdma import CdmaSettings from .connection import ConnectionSettings from .dcb import DcbSettings from .dummy import DummySettings from .eapol import EapolSettings from .ethernet import EthernetSettings from .ethtool import EthtoolSettings from .generic import GenericSettings from .gsm import GsmSettings from .hostname import HostnameSettings from .infiniband import InfinibandSettings from .ip_tunnel import IpTunnelSettings from .ipv4 import Ipv4Settings from .ipv6 import Ipv6Settings from .lowpan import LowpanSettings from .macsec import MacsecSettings from .macvlan import MacvlanSettings from .match import MatchSettings from .olpc_mesh import OlpcMeshSettings from .ovs_bridge import OvsBridgeSettings from .ovs_dpdk import OvsDpdkSettings from .ovs_external_ids import OvsExternalIdsSettings from .ovs_interface import OvsInterfaceSettings from .ovs_patch import OvsPatchSettings from .ovs_port import OvsPortSettings from .ppp import PppSettings from .pppoe import PppoeSettings from .proxy import ProxySettings from .serial import SerialSettings from .sriov import SriovSettings from .tc import TcSettings from .team import TeamSettings from .team_port import TeamPortSettings from .tun import TunSettings from .user import UserSettings from .veth import VethSettings from .vlan import VlanSettings from .vpn import VpnSettings from .vrf import VrfSettings from .vxlan import VxlanSettings from .wifi_p2p import WifiP2PSettings from .wimax import WimaxSettings from .wireguard import WireguardSettings from .wireless import WirelessSettings from .wireless_security import WirelessSecuritySettings from .wpan import WpanSettings from ..types import NetworkManagerConnectionProperties, SettingsDict @dataclass class ConnectionProfile: """ Connection profiles ------------------- NetworkManager is based on a concept of connection profiles, most often referred to just as "connections". Connection profiles provide a network configuration. When NetworkManager activates a connection profile on a network device, the configuration will be applied and an active network connection will be established. Users are free to create as many connection profiles as they see fit. Thus they are flexible in having various network configurations for different networking needs: https://networkmanager.pages.freedesktop.org/NetworkManager/NetworkManager/nm-settings-dbus.html Connection profiles are handled by NetworkManager via a settings service and are exported on D-Bus (/org/freedesktop/NetworkManager/Settings/) Definition of a connection profile: A specific, encapsulated, independent group of settings describing all the configuration required to connect to a specific network. It is referred to by a unique identifier called the UUID. A connection profile is tied to a one specific device type, but not necessarily a specific hardware device. A connection profile is composed of one or more Settings objects. Settings objects ---------------- A group of related key/value pairs describing a specific piece of a Connection (profile). Keys are also referred to as properties. """ # The list of the settings classes was generated by # tools/generate-settings-dataclasses-jinja.py which generates the # settings classes themselfes as well. # If possible, please make changes by also updating the script. # start of the generated list of settings classes adsl: Optional[AdslSettings] = field( metadata={'dbus_name': 'adsl', 'settings_class': AdslSettings}, default=None, ) bluetooth: Optional[BluetoothSettings] = field( metadata={'dbus_name': 'bluetooth', 'settings_class': BluetoothSettings}, default=None, ) bond: Optional[BondSettings] = field( metadata={'dbus_name': 'bond', 'settings_class': BondSettings}, default=None, ) bond_port: Optional[BondPortSettings] = field( metadata={'dbus_name': 'bond-port', 'settings_class': BondPortSettings}, default=None, ) bridge: Optional[BridgeSettings] = field( metadata={'dbus_name': 'bridge', 'settings_class': BridgeSettings}, default=None, ) bridge_port: Optional[BridgePortSettings] = field( metadata={'dbus_name': 'bridge-port', 'settings_class': BridgePortSettings}, default=None, ) cdma: Optional[CdmaSettings] = field( metadata={'dbus_name': 'cdma', 'settings_class': CdmaSettings}, default=None, ) connection: ConnectionSettings = field( metadata={'dbus_name': 'connection', 'settings_class': ConnectionSettings}, default_factory=ConnectionSettings, ) dcb: Optional[DcbSettings] = field( metadata={'dbus_name': 'dcb', 'settings_class': DcbSettings}, default=None, ) dummy: Optional[DummySettings] = field( metadata={'dbus_name': 'dummy', 'settings_class': DummySettings}, default=None, ) eapol: Optional[EapolSettings] = field( metadata={'dbus_name': '802-1x', 'settings_class': EapolSettings}, default=None, ) ethernet: Optional[EthernetSettings] = field( metadata={'dbus_name': '802-3-ethernet', 'settings_class': EthernetSettings}, default=None, ) ethtool: Optional[EthtoolSettings] = field( metadata={'dbus_name': 'ethtool', 'settings_class': EthtoolSettings}, default=None, ) generic: Optional[GenericSettings] = field( metadata={'dbus_name': 'generic', 'settings_class': GenericSettings}, default=None, ) gsm: Optional[GsmSettings] = field( metadata={'dbus_name': 'gsm', 'settings_class': GsmSettings}, default=None, ) hostname: Optional[HostnameSettings] = field( metadata={'dbus_name': 'hostname', 'settings_class': HostnameSettings}, default=None, ) infiniband: Optional[InfinibandSettings] = field( metadata={'dbus_name': 'infiniband', 'settings_class': InfinibandSettings}, default=None, ) ip_tunnel: Optional[IpTunnelSettings] = field( metadata={'dbus_name': 'ip-tunnel', 'settings_class': IpTunnelSettings}, default=None, ) ipv4: Optional[Ipv4Settings] = field( metadata={'dbus_name': 'ipv4', 'settings_class': Ipv4Settings}, default=None, ) ipv6: Optional[Ipv6Settings] = field( metadata={'dbus_name': 'ipv6', 'settings_class': Ipv6Settings}, default=None, ) lowpan: Optional[LowpanSettings] = field( metadata={'dbus_name': '6lowpan', 'settings_class': LowpanSettings}, default=None, ) macsec: Optional[MacsecSettings] = field( metadata={'dbus_name': 'macsec', 'settings_class': MacsecSettings}, default=None, ) macvlan: Optional[MacvlanSettings] = field( metadata={'dbus_name': 'macvlan', 'settings_class': MacvlanSettings}, default=None, ) match: Optional[MatchSettings] = field( metadata={'dbus_name': 'match', 'settings_class': MatchSettings}, default=None, ) olpc_mesh: Optional[OlpcMeshSettings] = field( metadata={'dbus_name': '802-11-olpc-mesh', 'settings_class': OlpcMeshSettings}, default=None, ) ovs_bridge: Optional[OvsBridgeSettings] = field( metadata={'dbus_name': 'ovs-bridge', 'settings_class': OvsBridgeSettings}, default=None, ) ovs_dpdk: Optional[OvsDpdkSettings] = field( metadata={'dbus_name': 'ovs-dpdk', 'settings_class': OvsDpdkSettings}, default=None, ) ovs_external_ids: Optional[OvsExternalIdsSettings] = field( metadata={'dbus_name': 'ovs-external-ids', 'settings_class': OvsExternalIdsSettings}, default=None, ) ovs_interface: Optional[OvsInterfaceSettings] = field( metadata={'dbus_name': 'ovs-interface', 'settings_class': OvsInterfaceSettings}, default=None, ) ovs_patch: Optional[OvsPatchSettings] = field( metadata={'dbus_name': 'ovs-patch', 'settings_class': OvsPatchSettings}, default=None, ) ovs_port: Optional[OvsPortSettings] = field( metadata={'dbus_name': 'ovs-port', 'settings_class': OvsPortSettings}, default=None, ) ppp: Optional[PppSettings] = field( metadata={'dbus_name': 'ppp', 'settings_class': PppSettings}, default=None, ) pppoe: Optional[PppoeSettings] = field( metadata={'dbus_name': 'pppoe', 'settings_class': PppoeSettings}, default=None, ) proxy: Optional[ProxySettings] = field( metadata={'dbus_name': 'proxy', 'settings_class': ProxySettings}, default=None, ) serial: Optional[SerialSettings] = field( metadata={'dbus_name': 'serial', 'settings_class': SerialSettings}, default=None, ) sriov: Optional[SriovSettings] = field( metadata={'dbus_name': 'sriov', 'settings_class': SriovSettings}, default=None, ) tc: Optional[TcSettings] = field( metadata={'dbus_name': 'tc', 'settings_class': TcSettings}, default=None, ) team: Optional[TeamSettings] = field( metadata={'dbus_name': 'team', 'settings_class': TeamSettings}, default=None, ) team_port: Optional[TeamPortSettings] = field( metadata={'dbus_name': 'team-port', 'settings_class': TeamPortSettings}, default=None, ) tun: Optional[TunSettings] = field( metadata={'dbus_name': 'tun', 'settings_class': TunSettings}, default=None, ) user: Optional[UserSettings] = field( metadata={'dbus_name': 'user', 'settings_class': UserSettings}, default=None, ) veth: Optional[VethSettings] = field( metadata={'dbus_name': 'veth', 'settings_class': VethSettings}, default=None, ) vlan: Optional[VlanSettings] = field( metadata={'dbus_name': 'vlan', 'settings_class': VlanSettings}, default=None, ) vpn: Optional[VpnSettings] = field( metadata={'dbus_name': 'vpn', 'settings_class': VpnSettings}, default=None, ) vrf: Optional[VrfSettings] = field( metadata={'dbus_name': 'vrf', 'settings_class': VrfSettings}, default=None, ) vxlan: Optional[VxlanSettings] = field( metadata={'dbus_name': 'vxlan', 'settings_class': VxlanSettings}, default=None, ) wifi_p2p: Optional[WifiP2PSettings] = field( metadata={'dbus_name': 'wifi-p2p', 'settings_class': WifiP2PSettings}, default=None, ) wimax: Optional[WimaxSettings] = field( metadata={'dbus_name': 'wimax', 'settings_class': WimaxSettings}, default=None, ) wireguard: Optional[WireguardSettings] = field( metadata={'dbus_name': 'wireguard', 'settings_class': WireguardSettings}, default=None, ) wireless: Optional[WirelessSettings] = field( metadata={'dbus_name': '802-11-wireless', 'settings_class': WirelessSettings}, default=None, ) wireless_security: Optional[WirelessSecuritySettings] = field( metadata={'dbus_name': '802-11-wireless-security', 'settings_class': WirelessSecuritySettings}, default=None, ) wpan: Optional[WpanSettings] = field( metadata={'dbus_name': 'wpan', 'settings_class': WpanSettings}, default=None, ) # end of the generated list of settings classes def to_dbus(self) -> NetworkManagerConnectionProperties: new_dict: NetworkManagerConnectionProperties = {} for x in fields(self): value = getattr(self, x.name) if value is None: continue new_dict[x.metadata['dbus_name']] = value.to_dbus() return new_dict def to_settings_dict(self, defaults: bool = False) -> SettingsDict: """Return a simple dictionary using the same key names like the dbus dict from to_dbus(), but without the dbus signatures returned by it. Contrary to dataclasses.asdict(), it provides the orignal dbus keys, e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type". The key names provided are exactly as documented in these tables: https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html param defaults: Whether properies with default values are returned. """ new_dict = {} for x in fields(self): settings_class = getattr(self, x.name) if settings_class: settingsdomain_dict = settings_class.to_settings_dict(defaults) if settingsdomain_dict != {}: new_dict[x.metadata['dbus_name']] = settingsdomain_dict return new_dict @property def dbus_name_to_settings_class(self) -> Dict[str, str]: return {f.metadata['dbus_name']: f.name for f in fields(self)} @classmethod def from_dbus(cls, dbus_dict: NetworkManagerConnectionProperties ) -> ConnectionProfile: for domain in ("ipv4", "ipv6"): group = dbus_dict.get(domain, None) if group: for key in ("addresses", "routes"): group.pop(key, None) try: unvarianted_options: Dict[str, Any] = { SETTING_DBUS_NAME_TO_NAME[k]: SETTING_TO_CLASS[k].from_dbus(v) for k, v in dbus_dict.items()} except KeyError as e: print(dbus_dict) raise e return cls(**unvarianted_options) @classmethod def from_settings_dict( cls, settings_dict: SettingsDict ) -> ConnectionProfile: """Return a ConnectionProfile created from a simple settings dict A simple settings dict uses the same keys as from_dbus() and to_dbus() but without the dbus variable signatures used by NetworkManader.py This means a simple settings dict does not use the underscore in keys like the attributes of this class have to use and use "id" and "type". """ unvarianted_options: Dict[str, Any] = { SETTING_DBUS_NAME_TO_NAME[k]: SETTING_TO_CLASS[k].from_dict(v) for k, v in settings_dict.items()} return cls(**unvarianted_options) def update(self, other: ConnectionProfile) -> None: """Update this connection profile with the settings from the other. Similar to dict.update method. """ for f in fields(other): settings_field_name = f.name other_settings = getattr(other, settings_field_name) if other_settings is None: continue my_settings = getattr(self, settings_field_name) if my_settings is None: setattr(self, settings_field_name, other_settings) continue for setting_field in fields(other_settings): setting_field_name = setting_field.name other_setting = getattr(other_settings, setting_field_name) if other_setting is None: continue setattr(my_settings, setting_field_name, other_setting) def update_secrets_generator( self) -> Generator[str, ConnectionProfile, None]: for attr_name, value in vars(self).items(): if value is None: continue if not isinstance(value, NetworkManagerSettingsMixin): continue secret_setting_name = value.secret_name if not secret_setting_name: continue secret_profile = yield secret_setting_name current_setting_secrets = getattr(secret_profile, attr_name) for secret_attribute in value.secret_fields_names: setattr( value, secret_attribute, getattr( current_setting_secrets, secret_attribute, ), ) SETTING_DBUS_NAME_TO_NAME: Dict[str, str] = { f.metadata['dbus_name']: f.name for f in fields(ConnectionProfile) } SETTING_TO_CLASS: Dict[str, NetworkManagerSettingsMixin] = { f.metadata['dbus_name']: f.metadata['settings_class'] for f in fields(ConnectionProfile) } python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/proxy.py000066400000000000000000000025761442124064700304150ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class ProxySettings(NetworkManagerSettingsMixin): """WWW Proxy Settings""" browser_only: Optional[bool] = field( metadata={ 'dbus_name': 'browser-only', 'dbus_type': 'b', }, default=None, ) """Whether the proxy configuration is for browser only.""" method: Optional[int] = field( metadata={ 'dbus_name': 'method', 'dbus_type': 'i', }, default=None, ) """Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)""" pac_script: Optional[str] = field( metadata={ 'dbus_name': 'pac-script', 'dbus_type': 's', }, default=None, ) """PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.""" pac_url: Optional[str] = field( metadata={ 'dbus_name': 'pac-url', 'dbus_type': 's', }, default=None, ) """PAC URL for obtaining PAC file.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/serial.py000066400000000000000000000033411442124064700305020ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class SerialSettings(NetworkManagerSettingsMixin): """Serial Link Settings""" baud: Optional[int] = field( metadata={ 'dbus_name': 'baud', 'dbus_type': 'u', }, default=None, ) """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.""" bits: Optional[int] = field( metadata={ 'dbus_name': 'bits', 'dbus_type': 'u', }, default=None, ) """Byte-width of the serial communication. The 8 in "8n1" for example.""" parity: Optional[int] = field( metadata={ 'dbus_name': 'parity', 'dbus_type': 'y', }, default=None, ) """Parity setting of the serial port.""" send_delay: Optional[int] = field( metadata={ 'dbus_name': 'send-delay', 'dbus_type': 't', }, default=None, ) """Time to delay between each byte sent to the modem, in microseconds.""" stopbits: Optional[int] = field( metadata={ 'dbus_name': 'stopbits', 'dbus_type': 'u', }, default=None, ) """Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/sriov.py000066400000000000000000000051531442124064700303700ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import Vfs @dataclass class SriovSettings(NetworkManagerSettingsMixin): """SR-IOV settings""" autoprobe_drivers: Optional[int] = field( metadata={ 'dbus_name': 'autoprobe-drivers', 'dbus_type': 'i', }, default=None, ) """Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).""" total_vfs: Optional[int] = field( metadata={ 'dbus_name': 'total-vfs', 'dbus_type': 'u', }, default=None, ) """The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.""" vfs: Optional[List[Vfs]] = field( metadata={ 'dbus_name': 'vfs', 'dbus_type': 'aa{sv}', 'dbus_inner_class': Vfs, }, default=None, ) """Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/tc.py000066400000000000000000000032111442124064700276250ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import Qdiscs, Tfilters @dataclass class TcSettings(NetworkManagerSettingsMixin): """Linux Traffic Control Settings""" qdiscs: Optional[List[Qdiscs]] = field( metadata={ 'dbus_name': 'qdiscs', 'dbus_type': 'aa{sv}', 'dbus_inner_class': Qdiscs, }, default=None, ) """Array of TC queueing disciplines. When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.""" tfilters: Optional[List[Tfilters]] = field( metadata={ 'dbus_name': 'tfilters', 'dbus_type': 'aa{sv}', 'dbus_inner_class': Tfilters, }, default=None, ) """Array of TC traffic filters. When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/team.py000066400000000000000000000126411442124064700301540ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import LinkWatchers @dataclass class TeamSettings(NetworkManagerSettingsMixin): """Teaming Settings""" config: Optional[str] = field( metadata={ 'dbus_name': 'config', 'dbus_type': 's', }, default=None, ) """The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.""" interface_name: Optional[str] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 's', }, default=None, ) """Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.""" link_watchers: Optional[List[LinkWatchers]] = field( metadata={ 'dbus_name': 'link-watchers', 'dbus_type': 'aa{sv}', 'dbus_inner_class': LinkWatchers, }, default=None, ) """Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source- host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.""" mcast_rejoin_count: Optional[int] = field( metadata={ 'dbus_name': 'mcast-rejoin-count', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd mcast_rejoin.count.""" mcast_rejoin_interval: Optional[int] = field( metadata={ 'dbus_name': 'mcast-rejoin-interval', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd mcast_rejoin.interval.""" notify_peers_count: Optional[int] = field( metadata={ 'dbus_name': 'notify-peers-count', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd notify_peers.count.""" notify_peers_interval: Optional[int] = field( metadata={ 'dbus_name': 'notify-peers-interval', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd notify_peers.interval.""" runner: Optional[str] = field( metadata={ 'dbus_name': 'runner', 'dbus_type': 's', }, default=None, ) """Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".""" runner_active: Optional[bool] = field( metadata={ 'dbus_name': 'runner-active', 'dbus_type': 'b', }, default=None, ) """Corresponds to the teamd runner.active.""" runner_agg_select_policy: Optional[str] = field( metadata={ 'dbus_name': 'runner-agg-select-policy', 'dbus_type': 's', }, default=None, ) """Corresponds to the teamd runner.agg_select_policy.""" runner_fast_rate: Optional[bool] = field( metadata={ 'dbus_name': 'runner-fast-rate', 'dbus_type': 'b', }, default=None, ) """Corresponds to the teamd runner.fast_rate.""" runner_hwaddr_policy: Optional[str] = field( metadata={ 'dbus_name': 'runner-hwaddr-policy', 'dbus_type': 's', }, default=None, ) """Corresponds to the teamd runner.hwaddr_policy.""" runner_min_ports: Optional[int] = field( metadata={ 'dbus_name': 'runner-min-ports', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd runner.min_ports.""" runner_sys_prio: Optional[int] = field( metadata={ 'dbus_name': 'runner-sys-prio', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd runner.sys_prio.""" runner_tx_balancer: Optional[str] = field( metadata={ 'dbus_name': 'runner-tx-balancer', 'dbus_type': 's', }, default=None, ) """Corresponds to the teamd runner.tx_balancer.name.""" runner_tx_balancer_interval: Optional[int] = field( metadata={ 'dbus_name': 'runner-tx-balancer-interval', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd runner.tx_balancer.interval.""" runner_tx_hash: Optional[List[str]] = field( metadata={ 'dbus_name': 'runner-tx-hash', 'dbus_type': 'as', }, default=None, ) """Corresponds to the teamd runner.tx_hash.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/team_port.py000066400000000000000000000055671442124064700312310ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import LinkWatchers @dataclass class TeamPortSettings(NetworkManagerSettingsMixin): """Team Port Settings""" config: Optional[str] = field( metadata={ 'dbus_name': 'config', 'dbus_type': 's', }, default=None, ) """The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.""" lacp_key: Optional[int] = field( metadata={ 'dbus_name': 'lacp-key', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd ports.PORTIFNAME.lacp_key.""" lacp_prio: Optional[int] = field( metadata={ 'dbus_name': 'lacp-prio', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd ports.PORTIFNAME.lacp_prio.""" link_watchers: Optional[List[LinkWatchers]] = field( metadata={ 'dbus_name': 'link-watchers', 'dbus_type': 'aa{sv}', 'dbus_inner_class': LinkWatchers, }, default=None, ) """Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source- host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.""" prio: Optional[int] = field( metadata={ 'dbus_name': 'prio', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd ports.PORTIFNAME.prio.""" queue_id: Optional[int] = field( metadata={ 'dbus_name': 'queue-id', 'dbus_type': 'i', }, default=None, ) """Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.""" sticky: Optional[bool] = field( metadata={ 'dbus_name': 'sticky', 'dbus_type': 'b', }, default=None, ) """Corresponds to the teamd ports.PORTIFNAME.sticky.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/tun.py000066400000000000000000000042561442124064700300370ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class TunSettings(NetworkManagerSettingsMixin): """Tunnel Settings""" group: Optional[str] = field( metadata={ 'dbus_name': 'group', 'dbus_type': 's', }, default=None, ) """The group ID which will own the device. If set to NULL everyone will be able to use the device.""" mode: Optional[int] = field( metadata={ 'dbus_name': 'mode', 'dbus_type': 'u', }, default=None, ) """The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.""" multi_queue: Optional[bool] = field( metadata={ 'dbus_name': 'multi-queue', 'dbus_type': 'b', }, default=None, ) """If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.""" owner: Optional[str] = field( metadata={ 'dbus_name': 'owner', 'dbus_type': 's', }, default=None, ) """The user ID which will own the device. If set to NULL everyone will be able to use the device.""" pi: Optional[bool] = field( metadata={ 'dbus_name': 'pi', 'dbus_type': 'b', }, default=None, ) """If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.""" vnet_hdr: Optional[bool] = field( metadata={ 'dbus_name': 'vnet-hdr', 'dbus_type': 'b', }, default=None, ) """If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/user.py000066400000000000000000000015541442124064700302050ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Dict, Optional from .base import NetworkManagerSettingsMixin @dataclass class UserSettings(NetworkManagerSettingsMixin): """General User Profile Settings""" data: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 'data', 'dbus_type': 'a{ss}', }, default=None, ) """A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/veth.py000066400000000000000000000012461442124064700301730ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class VethSettings(NetworkManagerSettingsMixin): """Veth Settings""" peer: Optional[str] = field( metadata={ 'dbus_name': 'peer', 'dbus_type': 's', }, default=None, ) """This property specifies the peer interface name of the veth. This property is mandatory.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/vlan.py000066400000000000000000000061141442124064700301640ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class VlanSettings(NetworkManagerSettingsMixin): """VLAN Settings""" egress_priority_map: Optional[List[str]] = field( metadata={ 'dbus_name': 'egress-priority-map', 'dbus_type': 'as', }, default=None, ) """For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".""" flags: Optional[int] = field( metadata={ 'dbus_name': 'flags', 'dbus_type': 'u', }, default=None, ) """One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.""" vlan_id: Optional[int] = field( metadata={ 'dbus_name': 'id', 'dbus_type': 'u', }, default=None, ) """The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.""" ingress_priority_map: Optional[List[str]] = field( metadata={ 'dbus_name': 'ingress-priority-map', 'dbus_type': 'as', }, default=None, ) """For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".""" interface_name: Optional[str] = field( metadata={ 'dbus_name': 'interface-name', 'dbus_type': 's', }, default=None, ) """Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/vpn.py000066400000000000000000000052751442124064700300360ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Dict, Optional from .base import NetworkManagerSettingsMixin @dataclass class VpnSettings(NetworkManagerSettingsMixin): """VPN Settings""" data: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 'data', 'dbus_type': 'a{ss}', }, default=None, ) """Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.""" persistent: Optional[bool] = field( metadata={ 'dbus_name': 'persistent', 'dbus_type': 'b', }, default=None, ) """If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.""" secrets: Optional[Dict[str, str]] = field( metadata={ 'dbus_name': 'secrets', 'dbus_type': 'a{ss}', }, default=None, ) """Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.""" service_type: Optional[str] = field( metadata={ 'dbus_name': 'service-type', 'dbus_type': 's', }, default=None, ) """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.""" timeout: Optional[int] = field( metadata={ 'dbus_name': 'timeout', 'dbus_type': 'u', }, default=None, ) """Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.""" user_name: Optional[str] = field( metadata={ 'dbus_name': 'user-name', 'dbus_type': 's', }, default=None, ) """If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/vrf.py000066400000000000000000000011511442124064700300150ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class VrfSettings(NetworkManagerSettingsMixin): """VRF settings""" table: Optional[int] = field( metadata={ 'dbus_name': 'table', 'dbus_type': 'u', }, default=None, ) """The routing table for this VRF.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/vxlan.py000066400000000000000000000106611442124064700303560ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class VxlanSettings(NetworkManagerSettingsMixin): """VXLAN Settings""" ageing: Optional[int] = field( metadata={ 'dbus_name': 'ageing', 'dbus_type': 'u', }, default=None, ) """Specifies the lifetime in seconds of FDB entries learnt by the kernel.""" destination_port: Optional[int] = field( metadata={ 'dbus_name': 'destination-port', 'dbus_type': 'u', }, default=None, ) """Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.""" vxlan_id: Optional[int] = field( metadata={ 'dbus_name': 'id', 'dbus_type': 'u', }, default=None, ) """Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.""" l2_miss: Optional[bool] = field( metadata={ 'dbus_name': 'l2-miss', 'dbus_type': 'b', }, default=None, ) """Specifies whether netlink LL ADDR miss notifications are generated.""" l3_miss: Optional[bool] = field( metadata={ 'dbus_name': 'l3-miss', 'dbus_type': 'b', }, default=None, ) """Specifies whether netlink IP ADDR miss notifications are generated.""" learning: Optional[bool] = field( metadata={ 'dbus_name': 'learning', 'dbus_type': 'b', }, default=None, ) """Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.""" limit: Optional[int] = field( metadata={ 'dbus_name': 'limit', 'dbus_type': 'u', }, default=None, ) """Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.""" local: Optional[str] = field( metadata={ 'dbus_name': 'local', 'dbus_type': 's', }, default=None, ) """If given, specifies the source IP address to use in outgoing packets.""" parent: Optional[str] = field( metadata={ 'dbus_name': 'parent', 'dbus_type': 's', }, default=None, ) """If given, specifies the parent interface name or parent connection UUID.""" proxy: Optional[bool] = field( metadata={ 'dbus_name': 'proxy', 'dbus_type': 'b', }, default=None, ) """Specifies whether ARP proxy is turned on.""" remote: Optional[str] = field( metadata={ 'dbus_name': 'remote', 'dbus_type': 's', }, default=None, ) """Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.""" rsc: Optional[bool] = field( metadata={ 'dbus_name': 'rsc', 'dbus_type': 'b', }, default=None, ) """Specifies whether route short circuit is turned on.""" source_port_max: Optional[int] = field( metadata={ 'dbus_name': 'source-port-max', 'dbus_type': 'u', }, default=None, ) """Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.""" source_port_min: Optional[int] = field( metadata={ 'dbus_name': 'source-port-min', 'dbus_type': 'u', }, default=None, ) """Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.""" tos: Optional[int] = field( metadata={ 'dbus_name': 'tos', 'dbus_type': 'u', }, default=None, ) """Specifies the TOS value to use in outgoing packets.""" ttl: Optional[int] = field( metadata={ 'dbus_name': 'ttl', 'dbus_type': 'u', }, default=None, ) """Specifies the time-to-live value to use in outgoing packets.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wifi_p2p.py000066400000000000000000000030161442124064700307410ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class WifiP2PSettings(NetworkManagerSettingsMixin): """Wi-Fi P2P Settings""" peer: Optional[str] = field( metadata={ 'dbus_name': 'peer', 'dbus_type': 's', }, default=None, ) """The P2P device that should be connected to. Currently, this is the only way to create or join a group.""" wfd_ies: Optional[bytes] = field( metadata={ 'dbus_name': 'wfd-ies', 'dbus_type': 'ay', }, default=None, ) """The Wi-Fi Display (WFD) Information Elements (IEs) to set. Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.""" wps_method: Optional[int] = field( metadata={ 'dbus_name': 'wps-method', 'dbus_type': 'u', }, default=None, ) """Flags indicating which mode of WPS is to be used. There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wimax.py000066400000000000000000000020431442124064700303460ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class WimaxSettings(NetworkManagerSettingsMixin): """WiMax Settings""" mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 'ay', }, default=None, ) """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).""" network_name: Optional[str] = field( metadata={ 'dbus_name': 'network-name', 'dbus_type': 's', }, default=None, ) """Network Service Provider (NSP) name of the WiMAX network this connection should use.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wireguard.py000066400000000000000000000113461442124064700312200ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Any, List, Optional, Tuple from .base import NetworkManagerSettingsMixin from .datatypes import WireguardPeers @dataclass class WireguardSettings(NetworkManagerSettingsMixin): """WireGuard Settings""" secret_fields_names = ['private_key'] secret_name = 'wireguard' fwmark: Optional[int] = field( metadata={ 'dbus_name': 'fwmark', 'dbus_type': 'u', }, default=None, ) """The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.""" ip4_auto_default_route: Optional[int] = field( metadata={ 'dbus_name': 'ip4-auto-default-route', 'dbus_type': 'i', }, default=None, ) """Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.""" ip6_auto_default_route: Optional[int] = field( metadata={ 'dbus_name': 'ip6-auto-default-route', 'dbus_type': 'i', }, default=None, ) """Like ip4-auto-default-route, but for the IPv6 default route.""" listen_port: Optional[int] = field( metadata={ 'dbus_name': 'listen-port', 'dbus_type': 'u', }, default=None, ) """The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.""" peer_routes: Optional[bool] = field( metadata={ 'dbus_name': 'peer-routes', 'dbus_type': 'b', }, default=None, ) """Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.""" peers: Optional[List[WireguardPeers]] = field( metadata={ 'dbus_name': 'peers', 'dbus_type': 'aa{sv}', 'dbus_inner_class': WireguardPeers, }, default=None, ) """Array of dictionaries for the WireGuard peers.""" private_key: Optional[str] = field( metadata={ 'dbus_name': 'private-key', 'dbus_type': 's', }, default=None, ) """The 256 bit private-key in base64 encoding.""" private_key_flags: Optional[int] = field( metadata={ 'dbus_name': 'private-key-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "private-key" property.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wireless.py000066400000000000000000000304221442124064700310600ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class WirelessSettings(NetworkManagerSettingsMixin): """Wi-Fi Settings""" ap_isolation: Optional[int] = field( metadata={ 'dbus_name': 'ap-isolation', 'dbus_type': 'i', }, default=None, ) """Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. If set to NM_TERNARY_FALSE (0), devices can talk to each other. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).""" assigned_mac_address: Optional[str] = field( metadata={ 'dbus_name': 'assigned-mac-address', 'dbus_type': 's', }, default=None, ) """The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned- mac-address".""" band: Optional[str] = field( metadata={ 'dbus_name': 'band', 'dbus_type': 's', }, default=None, ) """802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.""" bssid: Optional[bytes] = field( metadata={ 'dbus_name': 'bssid', 'dbus_type': 'ay', }, default=None, ) """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. Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.""" channel: Optional[int] = field( metadata={ 'dbus_name': 'channel', 'dbus_type': 'u', }, default=None, ) """Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.""" cloned_mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'cloned-mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".""" generate_mac_address_mask: Optional[str] = field( metadata={ 'dbus_name': 'generate-mac-address-mask', 'dbus_type': 's', }, default=None, ) """With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.""" hidden: Optional[bool] = field( metadata={ 'dbus_name': 'hidden', 'dbus_type': 'b', }, default=None, ) """If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.""" mac_address: Optional[bytes] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 'ay', }, default=None, ) """If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).""" mac_address_blacklist: Optional[List[str]] = field( metadata={ 'dbus_name': 'mac-address-blacklist', 'dbus_type': 'as', }, default=None, ) """A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").""" mac_address_randomization: Optional[int] = field( metadata={ 'dbus_name': 'mac-address-randomization', 'dbus_type': 'u', }, default=None, ) """One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).""" mode: Optional[str] = field( metadata={ 'dbus_name': 'mode', 'dbus_type': 's', }, default=None, ) """Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.""" mtu: Optional[int] = field( metadata={ 'dbus_name': 'mtu', 'dbus_type': 'u', }, default=None, ) """If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.""" powersave: Optional[int] = field( metadata={ 'dbus_name': 'powersave', 'dbus_type': 'u', }, default=None, ) """One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.""" rate: Optional[int] = field( metadata={ 'dbus_name': 'rate', 'dbus_type': 'u', }, default=None, ) """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.""" seen_bssids: Optional[List[str]] = field( metadata={ 'dbus_name': 'seen-bssids', 'dbus_type': 'as', }, default=None, ) """A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.""" ssid: Optional[bytes] = field( metadata={ 'dbus_name': 'ssid', 'dbus_type': 'ay', }, default=None, ) """SSID of the Wi-Fi network. Must be specified.""" tx_power: Optional[int] = field( metadata={ 'dbus_name': 'tx-power', 'dbus_type': 'u', }, default=None, ) """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.""" wake_on_wlan: Optional[int] = field( metadata={ 'dbus_name': 'wake-on-wlan', 'dbus_type': 'u', }, default=None, ) """The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wireless_security.py000066400000000000000000000215771442124064700330220ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import List, Optional from .base import NetworkManagerSettingsMixin @dataclass class WirelessSecuritySettings(NetworkManagerSettingsMixin): """Wi-Fi Security Settings""" secret_fields_names = ['leap_password', 'psk'] secret_name = '802-11-wireless-security' auth_alg: Optional[str] = field( metadata={ 'dbus_name': 'auth-alg', 'dbus_type': 's', }, default=None, ) """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.""" fils: Optional[int] = field( metadata={ 'dbus_name': 'fils', 'dbus_type': 'i', }, default=None, ) """Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.""" group: Optional[List[str]] = field( metadata={ 'dbus_name': 'group', 'dbus_type': 'as', }, default=None, ) """A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".""" key_mgmt: Optional[str] = field( metadata={ 'dbus_name': 'key-mgmt', 'dbus_type': 's', }, default=None, ) """Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.""" leap_password: Optional[str] = field( metadata={ 'dbus_name': 'leap-password', 'dbus_type': 's', }, default=None, ) """The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").""" leap_password_flags: Optional[int] = field( metadata={ 'dbus_name': 'leap-password-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "leap-password" property.""" leap_username: Optional[str] = field( metadata={ 'dbus_name': 'leap-username', 'dbus_type': 's', }, default=None, ) """The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").""" pairwise: Optional[List[str]] = field( metadata={ 'dbus_name': 'pairwise', 'dbus_type': 'as', }, default=None, ) """A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".""" pmf: Optional[int] = field( metadata={ 'dbus_name': 'pmf', 'dbus_type': 'i', }, default=None, ) """Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.""" proto: Optional[List[str]] = field( metadata={ 'dbus_name': 'proto', 'dbus_type': 'as', }, default=None, ) """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.""" psk: Optional[str] = field( metadata={ 'dbus_name': 'psk', 'dbus_type': 's', }, default=None, ) """Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.""" psk_flags: Optional[int] = field( metadata={ 'dbus_name': 'psk-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "psk" property.""" wep_key_flags: Optional[int] = field( metadata={ 'dbus_name': 'wep-key-flags', 'dbus_type': 'u', }, default=None, ) """Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.""" wep_key_type: Optional[int] = field( metadata={ 'dbus_name': 'wep-key-type', 'dbus_type': 'u', }, default=None, ) """Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de- facto MD5 method to derive the actual WEP key.""" wep_key0: Optional[str] = field( metadata={ 'dbus_name': 'wep-key0', 'dbus_type': 's', }, default=None, ) """Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.""" wep_key1: Optional[str] = field( metadata={ 'dbus_name': 'wep-key1', 'dbus_type': 's', }, default=None, ) """Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.""" wep_key2: Optional[str] = field( metadata={ 'dbus_name': 'wep-key2', 'dbus_type': 's', }, default=None, ) """Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.""" wep_key3: Optional[str] = field( metadata={ 'dbus_name': 'wep-key3', 'dbus_type': 's', }, default=None, ) """Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.""" wep_tx_keyidx: Optional[int] = field( metadata={ 'dbus_name': 'wep-tx-keyidx', 'dbus_type': 'u', }, default=None, ) """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.""" wps_method: Optional[int] = field( metadata={ 'dbus_name': 'wps-method', 'dbus_type': 'u', }, default=None, ) """Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/settings/wpan.py000066400000000000000000000034121442124064700301670ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import Optional from .base import NetworkManagerSettingsMixin @dataclass class WpanSettings(NetworkManagerSettingsMixin): """IEEE 802.15.4 (WPAN) MAC Settings""" channel: Optional[int] = field( metadata={ 'dbus_name': 'channel', 'dbus_type': 'i', }, default=None, ) """IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".""" mac_address: Optional[str] = field( metadata={ 'dbus_name': 'mac-address', 'dbus_type': 's', }, default=None, ) """If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.""" page: Optional[int] = field( metadata={ 'dbus_name': 'page', 'dbus_type': 'i', }, default=None, ) """IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".""" pan_id: Optional[int] = field( metadata={ 'dbus_name': 'pan-id', 'dbus_type': 'u', }, default=None, ) """IEEE 802.15.4 Personal Area Network (PAN) identifier.""" short_address: Optional[int] = field( metadata={ 'dbus_name': 'short-address', 'dbus_type': 'u', }, default=None, ) """Short IEEE 802.15.4 address to be used within a restricted environment.""" python-sdbus-networkmanager-2.0rc2/sdbus_async/networkmanager/types.py000066400000000000000000000026411442124064700265310ustar00rootroot00000000000000# Copyright (C) 2022 igo95862, bernhardkaindl # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from typing import Any, Dict, Tuple # Type aliases for network connection settings and properties # "Any" might be str, int, bool (e.g. autoconnect), List[Ip] and maybe others NetworkManagerSetting = Tuple[str, Any] # A settings domain, e.g. ipv4.*, ipv6.*, 802-11-wireless-security.*, etc: NetworkManagerSettingsDomain = Dict[str, NetworkManagerSetting] # All settings and properites of a connection, e.g. returned by get_settings() NetworkManagerConnectionProperties = Dict[str, NetworkManagerSettingsDomain] # All settings and properites of a connection, but without dbus signatures SettingsDict = Dict[str, Dict[str, Any]] python-sdbus-networkmanager-2.0rc2/sdbus_block/000077500000000000000000000000001442124064700217415ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/000077500000000000000000000000001442124064700247655ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/__init__.py000066400000000000000000000315121442124064700271000ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from .enums import ( AccessPointCapabilities, BluetoothCapabilities, ConnectionFlags, ConnectionState, ConnectionStateFlags, ConnectionStateReason, ConnectionType, ConnectivityState, DeviceCapabilities, DeviceInterfaceFlags, DeviceMetered, DeviceState, DeviceStateReason, DeviceType, IpTunnelMode, ModemCapabilities, NetworkManagerConnectivityState, NetworkManagerState, SecretAgentCapabilities, VpnFailure, VpnState, WiFiOperationMode, WirelessCapabilities, WpaSecurityFlags, ) from .exceptions import ( NetworkManagerAlreadyAsleepOrAwakeError, NetworkManagerAlreadyEnabledOrDisabledError, NetworkManagerBaseError, NetworkManagerConnectionAlreadyActiveError, NetworkManagerConnectionNotActiveError, NetworkManagerConnectionNotAvailableError, NetworkManagerDependencyFailedError, NetworkManagerFailedError, NetworkManagerInvalidArgumentsError, NetworkManagerMissingPluginError, NetworkManagerPermissionDeniedError, NetworkManagerUnknownConnectionError, NetworkManagerUnknownDeviceError, NetworkManagerUnknownLogDomainError, NetworkManagerUnknownLogLevelError, NmAgentManagerFailedError, NmAgentManagerInvalidIdentifierError, NmAgentManagerNoSecretsError, NmAgentManagerNotRegisteredError, NmAgentManagerPermissionDeniedError, NmAgentManagerUserCanceledError, NmConnectionFailedError, NmConnectionInvalidPropertyError, NmConnectionInvalidSettingError, NmConnectionMissingPropertyError, NmConnectionMissingSettingError, NmConnectionPropertyNotFoundError, NmConnectionPropertyNotSecretError, NmConnectionSettingNotFoundError, NmDeviceCreationFailedError, NmDeviceFailedError, NmDeviceIncompatibleConnectionError, NmDeviceInvalidArgumentError, NmDeviceInvalidConnectionError, NmDeviceMissingDependenciesError, NmDeviceNotActiveError, NmDeviceNotAllowedError, NmDeviceNotSoftwareError, NmDeviceSpecificObjectNotFoundError, NmDeviceVersionIdMismatchError, NmSecretManagerAgentCanceledError, NmSecretManagerFailedError, NmSecretManagerInvalidConnectionError, NmSecretManagerNoSecretsError, NmSecretManagerPermissionDeniedError, NmSecretManagerUserCanceledError, NmSettingsFailedError, NmSettingsInvalidArgumentsError, NmSettingsInvalidConnectionError, NmSettingsInvalidHostnameError, NmSettingsNotSupportedError, NmSettingsPermissionDeniedError, NmSettingsReadOnlyConnectionError, NmSettingsUuidExistsError, NmVpnPluginAlreadyStartedError, NmVpnPluginAlreadyStoppedError, NmVpnPluginBadArgumentsError, NmVpnPluginFailedError, NmVpnPluginInteractiveNotSupportedError, NmVpnPluginInvalidConnectionError, NmVpnPluginLaunchFailedError, NmVpnPluginStartingInProgressError, NmVpnPluginStoppingInProgressError, NmVpnPluginWrongStateError, ) from .interfaces_devices import ( NetworkManagerDeviceBluetoothInterface, NetworkManagerDeviceBondInterface, NetworkManagerDeviceBridgeInterface, NetworkManagerDeviceGenericInterface, NetworkManagerDeviceInterface, NetworkManagerDeviceIPTunnelInterface, NetworkManagerDeviceLowpanInterface, NetworkManagerDeviceMacsecInterface, NetworkManagerDeviceMacvlanInterface, NetworkManagerDeviceModemInterface, NetworkManagerDeviceOlpcMeshInterface, NetworkManagerDeviceOvsBridgeInterface, NetworkManagerDeviceOvsPortInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceTeamInterface, NetworkManagerDeviceTunInterface, NetworkManagerDeviceVethInterface, NetworkManagerDeviceVlanInterface, NetworkManagerDeviceVrfInterface, NetworkManagerDeviceVxlanInterface, NetworkManagerDeviceWifiP2PInterface, NetworkManagerDeviceWiredInterface, NetworkManagerDeviceWireGuardInterface, NetworkManagerDeviceWirelessInterface, NetworkManagerPPPInterface, ) from .interfaces_other import ( NetworkManagerAccessPointInterface, NetworkManagerCheckpointInterface, NetworkManagerConnectionActiveInterface, NetworkManagerDHCP4ConfigInterface, NetworkManagerDHCP6ConfigInterface, NetworkManagerDnsManagerInterface, NetworkManagerInterface, NetworkManagerIP4ConfigInterface, NetworkManagerIP6ConfigInterface, NetworkManagerSecretAgentInterface, NetworkManagerSecretAgentManagerInterface, NetworkManagerSettingsConnectionInterface, NetworkManagerSettingsInterface, NetworkManagerVPNConnectionInterface, NetworkManagerVPNPluginInterface, NetworkManagerWifiP2PPeerInterface, ) from .objects import ( AccessPoint, ActiveConnection, ActiveVPNConnection, ConfigCheckpoint, DHCPv4Config, DHCPv6Config, IPv4Config, IPv6Config, NetworkConnectionSettings, NetworkDeviceBluetooth, NetworkDeviceBond, NetworkDeviceBridge, NetworkDeviceGeneric, NetworkDeviceIpTunnel, NetworkDeviceMacsec, NetworkDeviceMacvlan, NetworkDeviceModem, NetworkDeviceOlpcMesh, NetworkDeviceOpenVSwitchBridge, NetworkDeviceOpenVSwitchPort, NetworkDevicePPP, NetworkDeviceTeam, NetworkDeviceTun, NetworkDeviceVeth, NetworkDeviceVlan, NetworkDeviceVrf, NetworkDeviceVxlan, NetworkDeviceWifiP2P, NetworkDeviceWired, NetworkDeviceWireGuard, NetworkDeviceWireless, NetworkManager, NetworkManagerAgentManager, NetworkManagerDnsManager, NetworkManagerSettings, WiFiP2PPeer, ) from .types import ( NetworkManagerConnectionProperties, NetworkManagerSetting, NetworkManagerSettingsDomain, SettingsDict, ) DEVICE_TYPE_TO_CLASS = { DeviceType.ETHERNET: NetworkDeviceWired, DeviceType.WIFI: NetworkDeviceWireless, DeviceType.BLUETOOTH: NetworkDeviceBluetooth, DeviceType.OLPC_MESH: NetworkDeviceOlpcMesh, DeviceType.VETH: NetworkDeviceVeth, DeviceType.WIREGUARD: NetworkDeviceWireGuard, DeviceType.PPP: NetworkDevicePPP, DeviceType.BRIDGE: NetworkDeviceBridge, DeviceType.MODEM: NetworkDeviceModem, } __all__ = ( # .enums 'AccessPointCapabilities', 'BluetoothCapabilities', 'ConnectionFlags', 'ConnectionState', 'ConnectionStateFlags', 'ConnectionStateReason', 'ConnectionType', 'ConnectivityState', 'DeviceCapabilities', 'DeviceInterfaceFlags', 'DeviceMetered', 'DeviceState', 'DeviceStateReason', 'DeviceType', 'IpTunnelMode', 'ModemCapabilities', 'NetworkManagerConnectivityState', 'NetworkManagerState', 'SecretAgentCapabilities', 'VpnFailure', 'VpnState', 'WiFiOperationMode', 'WirelessCapabilities', 'WpaSecurityFlags', # .exceptions 'NetworkManagerAlreadyAsleepOrAwakeError', 'NetworkManagerAlreadyEnabledOrDisabledError', 'NetworkManagerBaseError', 'NetworkManagerConnectionAlreadyActiveError', 'NetworkManagerConnectionNotActiveError', 'NetworkManagerConnectionNotAvailableError', 'NetworkManagerDependencyFailedError', 'NetworkManagerFailedError', 'NetworkManagerInvalidArgumentsError', 'NetworkManagerMissingPluginError', 'NetworkManagerPermissionDeniedError', 'NetworkManagerUnknownConnectionError', 'NetworkManagerUnknownDeviceError', 'NetworkManagerUnknownLogDomainError', 'NetworkManagerUnknownLogLevelError', 'NmAgentManagerFailedError', 'NmAgentManagerInvalidIdentifierError', 'NmAgentManagerNoSecretsError', 'NmAgentManagerNotRegisteredError', 'NmAgentManagerPermissionDeniedError', 'NmAgentManagerUserCanceledError', 'NmConnectionFailedError', 'NmConnectionInvalidPropertyError', 'NmConnectionInvalidSettingError', 'NmConnectionMissingPropertyError', 'NmConnectionMissingSettingError', 'NmConnectionPropertyNotFoundError', 'NmConnectionPropertyNotSecretError', 'NmConnectionSettingNotFoundError', 'NmDeviceCreationFailedError', 'NmDeviceFailedError', 'NmDeviceIncompatibleConnectionError', 'NmDeviceInvalidArgumentError', 'NmDeviceInvalidConnectionError', 'NmDeviceMissingDependenciesError', 'NmDeviceNotActiveError', 'NmDeviceNotAllowedError', 'NmDeviceNotSoftwareError', 'NmDeviceSpecificObjectNotFoundError', 'NmDeviceVersionIdMismatchError', 'NmSecretManagerAgentCanceledError', 'NmSecretManagerFailedError', 'NmSecretManagerInvalidConnectionError', 'NmSecretManagerNoSecretsError', 'NmSecretManagerPermissionDeniedError', 'NmSecretManagerUserCanceledError', 'NmSettingsFailedError', 'NmSettingsInvalidArgumentsError', 'NmSettingsInvalidConnectionError', 'NmSettingsInvalidHostnameError', 'NmSettingsNotSupportedError', 'NmSettingsPermissionDeniedError', 'NmSettingsReadOnlyConnectionError', 'NmSettingsUuidExistsError', 'NmVpnPluginAlreadyStartedError', 'NmVpnPluginAlreadyStoppedError', 'NmVpnPluginBadArgumentsError', 'NmVpnPluginFailedError', 'NmVpnPluginInteractiveNotSupportedError', 'NmVpnPluginInvalidConnectionError', 'NmVpnPluginLaunchFailedError', 'NmVpnPluginStartingInProgressError', 'NmVpnPluginStoppingInProgressError', 'NmVpnPluginWrongStateError', # .interfaces_devices 'NetworkManagerDeviceBluetoothInterface', 'NetworkManagerDeviceBondInterface', 'NetworkManagerDeviceBridgeInterface', 'NetworkManagerDeviceGenericInterface', 'NetworkManagerDeviceInterface', 'NetworkManagerDeviceIPTunnelInterface', 'NetworkManagerDeviceLowpanInterface', 'NetworkManagerDeviceMacsecInterface', 'NetworkManagerDeviceMacvlanInterface', 'NetworkManagerDeviceModemInterface', 'NetworkManagerDeviceOlpcMeshInterface', 'NetworkManagerDeviceOvsBridgeInterface', 'NetworkManagerDeviceOvsPortInterface', 'NetworkManagerDeviceStatisticsInterface', 'NetworkManagerDeviceTeamInterface', 'NetworkManagerDeviceTunInterface', 'NetworkManagerDeviceVethInterface', 'NetworkManagerDeviceVlanInterface', 'NetworkManagerDeviceVrfInterface', 'NetworkManagerDeviceVxlanInterface', 'NetworkManagerDeviceWifiP2PInterface', 'NetworkManagerDeviceWiredInterface', 'NetworkManagerDeviceWireGuardInterface', 'NetworkManagerDeviceWirelessInterface', 'NetworkManagerPPPInterface', # .interfaces_other 'NetworkManagerAccessPointInterface', 'NetworkManagerCheckpointInterface', 'NetworkManagerConnectionActiveInterface', 'NetworkManagerDHCP4ConfigInterface', 'NetworkManagerDHCP6ConfigInterface', 'NetworkManagerDnsManagerInterface', 'NetworkManagerInterface', 'NetworkManagerIP4ConfigInterface', 'NetworkManagerIP6ConfigInterface', 'NetworkManagerSecretAgentInterface', 'NetworkManagerSecretAgentManagerInterface', 'NetworkManagerSettingsConnectionInterface', 'NetworkManagerSettingsInterface', 'NetworkManagerVPNConnectionInterface', 'NetworkManagerVPNPluginInterface', 'NetworkManagerWifiP2PPeerInterface', # .objects 'AccessPoint', 'ActiveConnection', 'ActiveVPNConnection', 'ConfigCheckpoint', 'DHCPv4Config', 'DHCPv6Config', 'IPv4Config', 'IPv6Config', 'NetworkConnectionSettings', 'NetworkDeviceBluetooth', 'NetworkDeviceBond', 'NetworkDeviceBridge', 'NetworkDeviceGeneric', 'NetworkDeviceIpTunnel', 'NetworkDeviceMacsec', 'NetworkDeviceMacvlan', 'NetworkDeviceModem', 'NetworkDeviceOlpcMesh', 'NetworkDeviceOpenVSwitchBridge', 'NetworkDeviceOpenVSwitchPort', 'NetworkDevicePPP', 'NetworkDeviceTeam', 'NetworkDeviceTun', 'NetworkDeviceVeth', 'NetworkDeviceVlan', 'NetworkDeviceVrf', 'NetworkDeviceVxlan', 'NetworkDeviceWifiP2P', 'NetworkDeviceWired', 'NetworkDeviceWireGuard', 'NetworkDeviceWireless', 'NetworkManager', 'NetworkManagerAgentManager', 'NetworkManagerDnsManager', 'NetworkManagerSettings', 'WiFiP2PPeer', # .types 'NetworkManagerConnectionProperties', 'NetworkManagerSetting', 'NetworkManagerSettingsDomain', 'SettingsDict', 'DEVICE_TYPE_TO_CLASS', ) python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/enums.py000077700000000000000000000000001442124064700361512../../sdbus_async/networkmanager/enums.pyustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/exceptions.py000077700000000000000000000000001442124064700402352../../sdbus_async/networkmanager/exceptions.pyustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/interfaces_devices.py000066400000000000000000000720041442124064700311670ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import Any, Dict, List, Tuple from sdbus import DbusInterfaceCommon, dbus_method, dbus_property from .settings import ConnectionProfile class NetworkManagerDeviceBluetoothInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Bluetooth'): """Bluetooth device interface""" @dbus_property('s') def name(self) -> str: """Name of Bluetooth device""" raise NotImplementedError @dbus_property('u') def bt_capabilities(self) -> int: """Bluetooth device capabilities See :py:class:`BluetoothCapabilities` """ raise NotImplementedError class NetworkManagerDeviceBondInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Bond'): """Bond device interface""" @dbus_property('ao') def slaves(self) -> List[str]: """List of paths of enslaved devices""" raise NotImplementedError class NetworkManagerDeviceBridgeInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Bridge'): """Bridge device interface""" @dbus_property('ao') def slaves(self) -> List[str]: """List of paths of enslaved devices""" raise NotImplementedError class NetworkManagerDeviceGenericInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Generic'): """Generic device interface""" @dbus_property('s') def type_description(self) -> str: """Description of the interface type""" raise NotImplementedError class NetworkManagerDeviceIPTunnelInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.IPTunnel'): """IP tunnel device interface""" @dbus_property('u') def mode(self) -> int: """Tunnel mode See :py:class:`IpTunnelMode` """ raise NotImplementedError @dbus_property('o') def parent(self) -> str: """Object path of parent device""" raise NotImplementedError @dbus_property('s') def local(self) -> str: """Local endpoint""" raise NotImplementedError @dbus_property('s') def remote(self) -> str: """Remote endpoint""" raise NotImplementedError @dbus_property('y') def ttl(self) -> int: """Time to Live (TTL) 0 is special value meaning the packets inherit TTL value. """ raise NotImplementedError @dbus_property('y') def tos(self) -> int: """Type of service (IPv4) or traffic class (IPv6)""" raise NotImplementedError @dbus_property('b') def path_mtu_discovery(self) -> bool: """Whether path MTU discovery is enabled on this tunnel""" raise NotImplementedError @dbus_property('s') def input_key(self) -> str: """Key used for incoming packets""" raise NotImplementedError @dbus_property('s') def output_key(self) -> str: """Key used for outgoing packets""" raise NotImplementedError @dbus_property('y') def encapsulation_limit(self) -> int: """How many levels of enapsulation are permitted Only IPv6 tunnels """ raise NotImplementedError @dbus_property('u') def flow_label(self) -> int: """Flow label assigned to tunnel packets Only IPv6 tunnels """ raise NotImplementedError @dbus_property('u') def flags(self) -> int: """Tunnel flags Missing upstream documentation """ raise NotImplementedError class NetworkManagerDeviceLowpanInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Lowpan'): """6LoWPAN device interface""" @dbus_property('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError class NetworkManagerDeviceMacsecInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Macsec'): """MacSec device interface""" @dbus_property('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property('t') def sci(self) -> int: """Secure Channel Identifier""" raise NotImplementedError @dbus_property('y') def icv_length(self) -> int: """Length of Integrity Check Value""" raise NotImplementedError @dbus_property('t') def cipher_suite(self) -> int: """Set of cryptographic algorithms in use Not documented upstream. """ raise NotImplementedError @dbus_property('u') def window(self) -> int: """Size of replay window. (in number of packets)""" raise NotImplementedError @dbus_property('y') def encoding_sa(self) -> int: """Security Association in use""" raise NotImplementedError @dbus_property('s') def validation(self) -> str: """Validation mode for incoming packets * strict * check * disabled """ raise NotImplementedError @dbus_property('b') def encrypt(self) -> bool: """Whether encryption of transmitted frames is enabled""" raise NotImplementedError @dbus_property('b') def protect(self) -> bool: """Whether protection of transmitted frames is enabled""" raise NotImplementedError @dbus_property('b') def include_sci(self) -> bool: """Whether SCI is always included in transmitted SecTAG""" raise NotImplementedError @dbus_property( property_signature='b', property_name='Es', ) def end_station_enabled(self) -> bool: """Whether End Station bit is enabled in SecTAG""" raise NotImplementedError @dbus_property( property_signature='b', property_name='Scb', ) def scb_enabled(self) -> bool: """Whether Single Copy Broadcast is enabled in SecTAG""" raise NotImplementedError @dbus_property('b') def replay_protect(self) -> bool: """Whether replay protection is enabled""" raise NotImplementedError class NetworkManagerDeviceMacvlanInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Macvlan'): """MACVLAN device interface""" @dbus_property('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property('s') def mode(self) -> str: """MacVlan mode One of: * private * vepa * bridge * passthru """ raise NotImplementedError @dbus_property('b') def no_promisc(self) -> bool: """Whether this device is blocked from promiscuous mode""" raise NotImplementedError @dbus_property('b') def tap(self) -> bool: """Whether the device is macvtap""" raise NotImplementedError class NetworkManagerDeviceModemInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Modem'): """Modem device interface""" @dbus_property('u') def modem_capabilities(self) -> int: """Modem radio technology Switching the radio technology might require firmware reboot. See :py:class:`ModemCapabilities` """ raise NotImplementedError @dbus_property('u') def current_capabilities(self) -> int: """Current supported radio technologies without firmware reload""" raise NotImplementedError @dbus_property('s') def device_id(self) -> str: """Unique modem identifier""" raise NotImplementedError @dbus_property('s') def operator_code(self) -> str: """Mobile country codes (MCC) + mobile network codes (MNC) Blank if disconnected or not a 3GPP modem. """ raise NotImplementedError @dbus_property('s') def apn(self) -> str: """Access point name modem is connected to. Blank if disconnected. """ raise NotImplementedError class NetworkManagerDeviceOlpcMeshInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.OlpcMesh'): """OLPC Wireless Mesh device interface""" @dbus_property('o') def companion(self) -> str: """Path to companion device""" raise NotImplementedError @dbus_property('u') def active_channel(self) -> int: """Currently active channel""" raise NotImplementedError class NetworkManagerDeviceOvsBridgeInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.OvsBridge'): """Open vSwitch device interface""" @dbus_property('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError class NetworkManagerDeviceOvsPortInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.OvsPort'): """Open vSwitch port device interface""" @dbus_property('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError class NetworkManagerDeviceStatisticsInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Statistics'): """Device statistics interface""" @dbus_property('u') def refresh_rate_ms(self) -> int: """Refreshed rate of properties of this interface in milliseconds.""" raise NotImplementedError @dbus_property('t') def tx_bytes(self) -> int: """Number of transmitted bytes""" raise NotImplementedError @dbus_property('t') def rx_bytes(self) -> int: """Number of received bytes""" raise NotImplementedError class NetworkManagerDeviceTeamInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Team'): """Teaming device Aggregates multiple devices to a single one. Seems to be Network Manager specific type bond device. """ @dbus_property('ao') def slaves(self) -> List[str]: """List of paths to slave devices""" raise NotImplementedError @dbus_property('s') def config(self) -> str: """JSON config of the device""" raise NotImplementedError class NetworkManagerDeviceTunInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Tun'): """Userspace tunneling device interface""" @dbus_property('x') def owner(self) -> int: """User ID (UID) of the device owner""" raise NotImplementedError @dbus_property('x') def group(self) -> int: """Group ID (GID) of the device owner""" raise NotImplementedError @dbus_property('s') def mode(self) -> str: """Tunnel mode Either tun or tap """ raise NotImplementedError @dbus_property('b') def no_pi(self) -> bool: """If true no protocol info is prepended to packets""" raise NotImplementedError @dbus_property('b') def vnet_hdr(self) -> bool: """If true tunnel packets include virtio network header""" raise NotImplementedError @dbus_property('b') def multi_queue(self) -> bool: """If true callers can connect multiple times""" raise NotImplementedError class NetworkManagerDeviceVethInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Veth'): """Virtual Ethernet device interface""" @dbus_property('o') def peer(self) -> str: """Path to peer device""" raise NotImplementedError class NetworkManagerDeviceVlanInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Vlan'): """Virtual LAN device interface""" @dbus_property('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property('u') def vlan_id(self) -> int: """VLAN ID of this interface""" raise NotImplementedError class NetworkManagerDeviceVrfInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Vrf'): """Virtual routing and forwarding device interface""" @dbus_property('u') def table(self) -> int: """Routing table ID of this device""" raise NotImplementedError class NetworkManagerDeviceVxlanInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Vxlan'): """Virtual Extensible LAN device interface""" @dbus_property('o') def parent(self) -> str: """Path to parent device""" raise NotImplementedError @dbus_property( property_signature='u', property_name='Id' ) def vxlan_id(self) -> int: """VXLAN Network Identifier (VNI)""" raise NotImplementedError @dbus_property('s') def group(self) -> str: """Multicast IP group used to communicate (v4 or v6)""" raise NotImplementedError @dbus_property('s') def local(self) -> str: """Local IP address used to communicate""" raise NotImplementedError @dbus_property('y') def tos(self) -> int: """TOS field of IP packets""" raise NotImplementedError @dbus_property('y') def ttl(self) -> int: """TTL of IP packets""" raise NotImplementedError @dbus_property('b') def learning(self) -> bool: """If true VXLAN dynamically learns the remote IP address""" raise NotImplementedError @dbus_property('u') def ageing(self) -> int: """Interval in seconds at which kernel purges stale cached addresses""" raise NotImplementedError @dbus_property('u') def limit(self) -> int: """Maximum number of entries in forwarding table""" raise NotImplementedError @dbus_property('q') def dst_port(self) -> int: """Destination port for outgoing packets""" raise NotImplementedError @dbus_property('q') def src_port_min(self) -> int: """Lowest source port for outgoing packets""" raise NotImplementedError @dbus_property('q') def src_port_max(self) -> int: """Highest source port for outgoing packets""" raise NotImplementedError @dbus_property( property_signature='b', property_name='Proxy') def arp_proxy(self) -> bool: """If true ARP proxying is enabled""" raise NotImplementedError @dbus_property( property_signature='b', property_name='Rsc') def route_short_circuit(self) -> bool: """If true route short circuiting is enabled""" raise NotImplementedError @dbus_property('b') def l2miss(self) -> bool: """If true emit netlink notification on L2 switch misses""" raise NotImplementedError @dbus_property('b') def l3miss(self) -> bool: """If true emit netlink notification on L3 switch misses""" raise NotImplementedError class NetworkManagerDeviceWifiP2PInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.WifiP2P'): """Wi-Fi Peet to Peer device interface""" @dbus_method('a{sv}') def start_find( self, options: Dict[str, Tuple[str, Any]], ) -> None: """Start find operation for Wi-Fi P2P peers Options supported: * ``timeout`` of type "i" which is a number of seconds \ for search timeout between 1-600. Default 300. """ raise NotImplementedError @dbus_method() def stop_find(self) -> None: """Stop find operation""" raise NotImplementedError @dbus_property('ao') def peers(self) -> List[str]: """List of peer objects paths visible to this Wi-Fi device""" raise NotImplementedError class NetworkManagerDeviceWiredInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Wired'): """Wired Ethernet device interface""" @dbus_property('s') def perm_hw_address(self) -> str: """Permanent hardware address""" raise NotImplementedError @dbus_property('u') def speed(self) -> int: """Design speed of the device in megabits/second""" raise NotImplementedError @dbus_property('as') def s390_subchannels(self) -> List[str]: """Array of IBM Z Architecture S/390 subchannels""" raise NotImplementedError class NetworkManagerDeviceWireGuardInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.WireGuard'): """WireGuard device interface""" @dbus_property('ay') def public_key(self) -> bytes: """Public key of the device""" raise NotImplementedError @dbus_property('q') def listen_port(self) -> int: """UDP listening port for incoming connections""" raise NotImplementedError @dbus_property('u') def fw_mark(self) -> int: """Optional packet marker to set routing policy""" raise NotImplementedError class NetworkManagerDeviceWirelessInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device.Wireless'): """Wi-Fi device interface""" @dbus_method( result_signature='ao', ) def get_all_access_points( self, ) -> List[str]: """Return the list of paths to all access points visible Includes the hidden ones without SSID. """ raise NotImplementedError @dbus_method('a{sv}', ) def request_scan( self, options: Dict[str, Tuple[str, Any]], ) -> None: """Request to scan for Wi-Fi access points Options: * ``ssids`` of type 'ayy' (List[bytes]) """ raise NotImplementedError @dbus_property('s') def perm_hw_address(self) -> str: """Permanent hardware address""" raise NotImplementedError @dbus_property('u') def mode(self) -> int: """Operating mode of the device See :py:class:`WiFiOperationMode` """ raise NotImplementedError @dbus_property('u') def bitrate(self) -> int: """Bit rate currently used in kilobits/second""" raise NotImplementedError @dbus_property('ao') def access_points(self) -> List[str]: """List of paths of access point currently visible""" raise NotImplementedError @dbus_property('o') def active_access_point(self) -> str: """Path to currently used access point""" raise NotImplementedError @dbus_property('u') def wireless_capabilities(self) -> int: """List of wireless device capabilities See :py:class:`WirelessCapabilities` """ raise NotImplementedError @dbus_property('x') def last_scan(self) -> int: """Time in CLOCK_BOOTTIME milliseconds since last scan Value -1 means never scanned. """ raise NotImplementedError class NetworkManagerDeviceInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Device'): """Device interface with common functionality""" @dbus_method( input_signature='a{sa{sv}}tu', ) def reapply( self, connection: Dict[str, Dict[str, Tuple[str, Any]]], version_id: int, flags: int = 0, ) -> None: """Attempt to update the device configuration without deactivating :param connection: Optional connection settings to be reapplied :param version_id: Current version id of applied connection. :param flags: currently there are no flags so it should be zero """ raise NotImplementedError @dbus_method( input_signature='u', result_signature='a{sa{sv}}t', ) def get_applied_connection( self, flags: int = 0, ) -> Tuple[Dict[str, Dict[str, Tuple[str, Any]]], int]: """Get the currently applied connection on the device :param flags: Currently there are no flags so this should be zero :returns: Tuple of dictionary of connection settings \ and an int version id. """ raise NotImplementedError @dbus_method() def disconnect( self, ) -> None: """Disconnect device and prevent from automatically activating""" raise NotImplementedError @dbus_method() def delete( self, ) -> None: """Deletes the software device. Raises an exception if the device is a hardware device. """ raise NotImplementedError @dbus_property('s') def udi(self) -> str: """Not stable device identifier Should not be used for tracking connection. """ raise NotImplementedError @dbus_property('s') def path(self) -> str: """Device path as exposed by Udev""" raise NotImplementedError @dbus_property('s') def interface(self) -> str: """Name of device control interface (???)""" raise NotImplementedError @dbus_property('s') def ip_interface(self) -> str: """Name of device data interface (???)""" raise NotImplementedError @dbus_property('s') def driver(self) -> str: """Driver handling device""" raise NotImplementedError @dbus_property('s') def driver_version(self) -> str: """Driver version""" raise NotImplementedError @dbus_property('s') def firmware_version(self) -> str: """Firmware version of the device""" raise NotImplementedError @dbus_property('u') def capabilities(self) -> int: """Capabilities of the device See :py:class:`DeviceCapabilities` """ raise NotImplementedError @dbus_property('u') def state(self) -> int: """Device state. See :py:class:`DeviceState` """ raise NotImplementedError @dbus_property('(uu)') def state_reason(self) -> Tuple[int, int]: """Current state and the reason. See :py:class:`DeviceState` and :py:class:`DeviceStateReason` """ raise NotImplementedError @dbus_property('o') def active_connection(self) -> str: """Path of active connection object""" raise NotImplementedError @dbus_property('o') def ip4_config(self) -> str: """Path of Ip4Config object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property('o') def dhcp4_config(self) -> str: """Path of Dhcp4 object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property('o') def ip6_config(self) -> str: """Path to Ip6Config object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property('o') def dhcp6_config(self) -> str: """Path to Dhcp6 object Only valid when device is in ACTIVATED state. """ raise NotImplementedError @dbus_property('b') def managed(self) -> bool: """Whether or not this device is manager by NetworkManager This setting can be written. The value is not persistent on NetworkManager restarts. """ raise NotImplementedError @dbus_property('b') def autoconnect(self) -> bool: """If true device is allowed to auto connect Can be written. """ raise NotImplementedError @dbus_property('b') def firmware_missing(self) -> bool: """If true means the device is missing firmware""" raise NotImplementedError @dbus_property('b') def nm_plugin_missing(self) -> bool: """If true means the plugin for NetworkManager is missing""" raise NotImplementedError @dbus_property('u') def device_type(self) -> int: """Device type See :py:class:`DeviceType` """ raise NotImplementedError @dbus_property('ao') def available_connections(self) -> List[str]: """List of object paths to connections available""" raise NotImplementedError @dbus_property('s') def physical_port_id(self) -> str: """Physical network port of the device""" raise NotImplementedError @dbus_property('u') def mtu(self) -> int: """Maximum Transmission Unit""" raise NotImplementedError @dbus_property('u') def metered(self) -> int: """Whether the traffic is subject to limitations See :py:class:`DeviceMetered` """ raise NotImplementedError @dbus_property('aa{sv}') def lldp_neighbors(self) -> List[Dict[str, Tuple[str, Any]]]: """List of LLDP neighbors Each element is the dictionary of LLDP TLV names \ to variants values. """ raise NotImplementedError @dbus_property('b') def real(self) -> bool: """Whether this device is exists If it does not yet exist it can be automatically created \ if one of the available connections becomes activated. """ raise NotImplementedError @dbus_property('u') def ip4_connectivity(self) -> int: """IPv4 connectivity state See :py:class:`ConnectivityState` """ raise NotImplementedError @dbus_property('u') def ip6_connectivity(self) -> int: """IPv6 connectivity state See :py:class:`ConnectivityState` """ raise NotImplementedError @dbus_property('u') def interface_flags(self) -> int: """Interface flags See :py:class:`DeviceInterfaceFlags` """ raise NotImplementedError @dbus_property('s') def hw_address(self) -> str: """Hardware address""" raise NotImplementedError def get_applied_connection_profile( self ) -> Tuple[ConnectionProfile, int]: """Get the currently applied connection on the device. .. note:: This method cannot fetch secrets. Use :py:meth:`NetworkManagerSettingsConnectionInterfaceAsync.get_profile` to acquire profile with secrets. :returns: Tuple of profile and version id. :rtype: Tuple[ConnectionProfile, int] """ connection_vardict, version_id = self.get_applied_connection(0) return ConnectionProfile.from_dbus(connection_vardict), version_id def reapply_profile( self, profile: ConnectionProfile, version_id: int = 0, ) -> None: """Attempts to update the configuration of a device without deactivating it. :param ConnectionProfile profile: Connection profile to update with. :param int version_id: If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via :py:meth:`get_applied_connection_profile`. """ self.reapply(profile.to_dbus(), version_id, 0) class NetworkManagerPPPInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.PPP'): """Helper interface for PPP plugin""" @dbus_method( result_signature='ss', ) def need_secrets( self, ) -> Tuple[str, str]: """Need secrets? Returns the tuple of username and password """ raise NotImplementedError @dbus_method('a{sv}') def set_ip4_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv4 configuration""" raise NotImplementedError @dbus_method('a{sv}') def set_ip6_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv6 configuration""" raise NotImplementedError @dbus_method('u') def set_state( self, state: int, ) -> None: """Set connection state. Not documented upstream. """ raise NotImplementedError @dbus_method('i') def set_ifindex( self, ifindex: int, ) -> None: """Set input device index Not documented upstream. """ raise NotImplementedError python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/interfaces_other.py000066400000000000000000001053041442124064700306660ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import Any, Dict, List, Tuple from sdbus import DbusInterfaceCommon, dbus_method, dbus_property from .settings import ConnectionProfile from .types import NetworkManagerConnectionProperties class NetworkManagerAccessPointInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.AccessPoint'): """Interface representing Wi-Fi access point""" @dbus_property('u') def flags(self) -> int: """Flags describing capabilities of the point See :py:class:`AccessPointCapabilities` """ raise NotImplementedError @dbus_property('u') def wpa_flags(self) -> int: """Flags WPA authentication and encryption See :py:class:`WpaSecurityFlags` """ raise NotImplementedError @dbus_property('u') def rsn_flags(self) -> int: """Flags describing RSN (Robust Secure Network) capabilities See :py:class:`WpaSecurityFlags` """ raise NotImplementedError @dbus_property('ay') def ssid(self) -> bytes: """SSID of the access point. (name)""" raise NotImplementedError @dbus_property('u') def frequency(self) -> int: """Frequency in MHz""" raise NotImplementedError @dbus_property('s') def hw_address(self) -> str: """Hardware address (BSSID)""" raise NotImplementedError @dbus_property('u') def mode(self) -> int: """Mode of operation of access point See :py:class:`WiFiOperationMode` """ raise NotImplementedError @dbus_property('u') def max_bitrate(self) -> int: """Maximum bit rate of this access point. (in kilobits/second)""" raise NotImplementedError @dbus_property('y') def strength(self) -> int: """Current signal quality in % percent""" raise NotImplementedError @dbus_property('i') def last_seen(self) -> int: """Timestamp in CLOCK_BOOTTIME seconds since last seen in scan Value of -1 means that the point was never found in scans. """ raise NotImplementedError class NetworkManagerSecretAgentManagerInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.AgentManager'): """Secret Agent Manager""" @dbus_method('s') def register( self, identifier: str, ) -> None: """Identifies an agent. Only one agent in each user session may use same identifier. """ raise NotImplementedError @dbus_method('su') def register_with_capabilities( self, identifier: str, capabilities: int, ) -> None: """Same as register() but with agent capabilities See :py:class:`SecretAgentCapabilities` """ raise NotImplementedError @dbus_method() def unregister( self, ) -> None: """Notify NetworkManager that secret agent is no longer active""" raise NotImplementedError class NetworkManagerCheckpointInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Checkpoint'): """Network Manager configuration snapshot interface""" @dbus_property('ao') def devices(self) -> List[str]: """List of devices which are part of this checkpoint""" raise NotImplementedError @dbus_property('x') def created(self) -> int: """Snapohot creation time in CLOCK_BOOTTIME milliseconds""" raise NotImplementedError @dbus_property('u') def rollback_timeout(self) -> int: """Automatic tollback timeout in seconds or zero""" raise NotImplementedError class NetworkManagerConnectionActiveInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Connection.Active'): """Represents an attempt to connect to network""" @dbus_property('o') def connection(self) -> str: """Path of connection object""" raise NotImplementedError @dbus_property('o') def specific_object(self) -> str: """Specific object associated with active connection""" raise NotImplementedError @dbus_property('s') def id(self) -> str: """Connection id""" raise NotImplementedError @dbus_property('s') def uuid(self) -> str: """Connection UUID""" raise NotImplementedError @dbus_property( property_signature='s', property_name="Type" ) def connection_type(self) -> str: """Connection type""" raise NotImplementedError @dbus_property('ao') def devices(self) -> List[str]: """Array of devices object paths which are part of connection""" raise NotImplementedError @dbus_property('u') def state(self) -> int: """Connection state See :py:class:`ConnectionState` """ raise NotImplementedError @dbus_property('u') def state_flags(self) -> int: """Connection state flags See :py:class:`ConnectionStateFlags` """ raise NotImplementedError @dbus_property('b') def default(self) -> bool: """Whether or not this connection owns default IPv4 route""" raise NotImplementedError @dbus_property('o') def ip4_config(self) -> str: """Object path to Ip4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property('o') def dhcp4_config(self) -> str: """Object path to Dhcp4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property('b') def default6(self) -> bool: """Whether or not this connection owns default IPv6 route""" raise NotImplementedError @dbus_property('o') def ip6_config(self) -> str: """Object path to Ip4Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property('o') def dhcp6_config(self) -> str: """Object path to Dhcp6Config object Only valid if connection state is ACTIVATED """ raise NotImplementedError @dbus_property('b') def vpn(self) -> bool: """Whether this connection is a VPN""" raise NotImplementedError @dbus_property('o') def master(self) -> str: """Path to master device if this connection is a slave""" raise NotImplementedError class NetworkManagerVPNConnectionInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.VPN.Connection'): """VPN connection interface""" @dbus_property('u') def vpn_state(self) -> int: """VPN connection state See :py:class:`ConnectionState` """ raise NotImplementedError @dbus_property('s') def banner(self) -> str: """Banner string of VPN connection""" raise NotImplementedError class NetworkManagerDHCP4ConfigInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.DHCP4Config'): """DHCPv4 configuration""" @dbus_property('a{sv}') def options(self) -> Dict[str, Tuple[str, Any]]: """Options and configurations returned by DHCPv4 server""" raise NotImplementedError class NetworkManagerDHCP6ConfigInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.DHCP6Config'): """DHCPv6 configuration""" @dbus_property('a{sv}') def options(self) -> Dict[str, Tuple[str, Any]]: """Options and configurations returned by DHCPv6 server""" raise NotImplementedError class NetworkManagerDnsManagerInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.DnsManager'): """DNS configuration state""" @dbus_property('s') def mode(self) -> str: """Current DNS processing mode""" raise NotImplementedError @dbus_property('s') def rc_manager(self) -> str: """Current resolv.conf management mode""" raise NotImplementedError class NetworkManagerIP4ConfigInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.IP4Config'): """IPv4 configuration state""" @dbus_property('aa{sv}') def address_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of IP address data objects Each dictionary includes ``'address'`` item with IP address string \ and ``'prefix'`` with an int of prefix. Some addresses may include \ additional attributes. """ raise NotImplementedError @dbus_property('s') def gateway(self) -> str: """Gateway in use""" raise NotImplementedError @dbus_property('aa{sv}') def route_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of route data objects Each dictionary includes 'dest' (IP address string), 'prefix' (int). Some routes may include 'next-hop', 'metric' and additional attributes. """ raise NotImplementedError @dbus_property('aa{sv}') def nameserver_data(self) -> List[Dict[str, Tuple[str, Any]]]: """List of nameserver objects Currently, each dictionary only has the 'address' value. \ (string of IP address) """ raise NotImplementedError @dbus_property('as') def domains(self) -> List[str]: """List of domains this address belongs to.""" raise NotImplementedError @dbus_property('as') def searches(self) -> List[str]: """List of DNS searches""" raise NotImplementedError @dbus_property('as') def dns_options(self) -> List[str]: """List of dns options""" raise NotImplementedError @dbus_property('i') def dns_priority(self) -> int: """Relative priority of DNS servers""" raise NotImplementedError @dbus_property('as') def wins_server_data(self) -> List[str]: """Windows Internet Name Service servers""" raise NotImplementedError class NetworkManagerIP6ConfigInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.IP6Config'): """IPv6 configuration""" @dbus_property('aa{sv}') def address_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of IP address data objects Each dictionary includes ``'address'`` item with IP address string \ and ``'prefix'`` with an int of prefix. Some addresses may include \ additional attributes. """ raise NotImplementedError @dbus_property('s') def gateway(self) -> str: """Gateway in use""" raise NotImplementedError @dbus_property('aa{sv}') def route_data(self) -> List[Dict[str, Tuple[str, Any]]]: """Array of route data objects Each dictionary includes 'dest' (IP address string), 'prefix' (int). Some routes may include 'next-hop', 'metric' and additional attributes. """ raise NotImplementedError @dbus_property('aay') def nameservers(self) -> List[bytes]: """Nameservers in use""" raise NotImplementedError @dbus_property('as') def domains(self) -> List[str]: """List of domains this address belongs to.""" raise NotImplementedError @dbus_property('as') def searches(self) -> List[str]: """List of DNS searches""" raise NotImplementedError @dbus_property('as') def dns_options(self) -> List[str]: """List of dns options""" raise NotImplementedError @dbus_property('i') def dns_priority(self) -> int: """Relative priority of DNS servers""" raise NotImplementedError class NetworkManagerSecretAgentInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.SecretAgent'): """D-Bus interface that stores secrets such as Wi-Fi passwords""" @dbus_method( input_signature='a{sa{sv}}osasu', result_signature='a{sa{sv}}', ) def get_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, setting_name: str, hints: List[str], flags: int, ) -> Dict[str, Dict[str, Tuple[str, Any]]]: """Retrieve stored secrets""" raise NotImplementedError @dbus_method('os') def cancel_get_secrets( self, connection_path: str, setting_name: str, ) -> None: """Cancel pending get_secrets request""" raise NotImplementedError @dbus_method('a{sa{sv}}o') def save_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, ) -> None: """Save given secrets""" raise NotImplementedError @dbus_method('a{sa{sv}}o') def delete_secrets( self, connection: NetworkManagerConnectionProperties, connection_path: str, ) -> None: """Delete secrets""" raise NotImplementedError class NetworkManagerSettingsConnectionInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Settings.Connection'): """Represents a single network connection""" @dbus_method('a{sa{sv}}') def update( self, properties: NetworkManagerConnectionProperties, ) -> None: """Update connection settings. Replaces all previous settings and properties. """ raise NotImplementedError @dbus_method('a{sa{sv}}') def update_unsaved( self, properties: NetworkManagerConnectionProperties, ) -> None: """Update connection settings but do not save to disk""" raise NotImplementedError @dbus_method() def delete( self, ) -> None: """Delete connection""" raise NotImplementedError @dbus_method( result_signature='a{sa{sv}}', ) def get_settings( self, ) -> NetworkManagerConnectionProperties: """Get connection settings""" raise NotImplementedError @dbus_method( input_signature='s', result_signature='a{sa{sv}}', ) def get_secrets( self, setting_name: str, ) -> Dict[str, Dict[str, Tuple[str, Any]]]: """Get connection secrets""" raise NotImplementedError @dbus_method() def clear_secrets( self, ) -> None: """Clear connection secrets""" raise NotImplementedError @dbus_method() def save( self, ) -> None: """Save connection settings to storage""" raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}ua{sv}', result_signature='a{sv}', ) def update2( self, settings: NetworkManagerConnectionProperties, flags: int, args: Dict[str, Tuple[str, Any]], ) -> Dict[str, Tuple[str, Any]]: """Update connection settings""" raise NotImplementedError @dbus_property('b') def unsaved(self) -> bool: """If true some settings are not saved to disk""" raise NotImplementedError @dbus_property('u') def flags(self) -> int: """Connection flags See :py:class:`ConnectionFlags` """ raise NotImplementedError @dbus_property('s') def filename(self) -> str: """File that stores connection settings""" raise NotImplementedError def update_profile( self, profile: ConnectionProfile, save_to_disk: bool = False, ) -> None: """Update connection using the profile dataclass. :param ConnectionProfile profile: Connection profile to update with. :param bool save_to_disk: Make changes permanent by saving updated values to disk. By default changes are temporary. (saved only to RAM) """ flags = 0 if save_to_disk: flags |= 0x1 else: flags |= 0x2 self.update2(profile.to_dbus(), flags, {}) def get_profile(self, fetch_secrets: bool = True) -> ConnectionProfile: """Get the connection settings as the profile object. :param bool fetch_secrets: Retrieve secret values. (like VPN passwords) Makes additional calls to NetworkManager. """ profile = ConnectionProfile.from_dbus(self.get_settings()) if fetch_secrets: secrets_name_generator = profile.update_secrets_generator() try: secrets_name = next(secrets_name_generator) while True: secret_profile = ConnectionProfile.from_dbus( self.get_secrets(secrets_name)) secrets_name = secrets_name_generator.send(secret_profile) except StopIteration: ... return profile class NetworkManagerSettingsInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.Settings'): """Global NetworkManager settings""" @dbus_method( result_signature='ao', ) def list_connections( self, ) -> List[str]: """List of connection object paths""" raise NotImplementedError @dbus_method( input_signature='s', result_signature='o', ) def get_connection_by_uuid( self, uuid: str, ) -> str: """Get connection path by UUID""" raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}', result_signature='o', ) def add_connection( self, connection: NetworkManagerConnectionProperties, ) -> str: """Add connection and save to disk""" raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}', result_signature='o', ) def add_connection_unsaved( self, connection: NetworkManagerConnectionProperties, ) -> str: """Add connection and do not save""" raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}ua{sv}', result_signature='oa{sv}', ) def add_connection2( self, settings: NetworkManagerConnectionProperties, flags: int, args: Dict[str, Tuple[str, Any]], ) -> Tuple[str, Dict[str, Tuple[str, Any]]]: """Add connection. Flags indicate whether to save or not""" raise NotImplementedError @dbus_method( input_signature='as', result_signature='bas', ) def load_connections( self, filenames: List[str], ) -> Tuple[bool, List[str]]: """Load connections from filenames :returns: Tuple of success and list of failed connection filenames. """ raise NotImplementedError @dbus_method( result_signature='b', ) def reload_connections( self, ) -> bool: """Reload all connection from disk""" raise NotImplementedError @dbus_method('s') def save_hostname( self, hostname: str, ) -> None: """Save hostname to persistent configuration If blank hostname is cleared. """ raise NotImplementedError @dbus_property('ao') def connections(self) -> List[str]: """List of paths to connection objects""" raise NotImplementedError @dbus_property('s') def hostname(self) -> str: """Current hostname""" raise NotImplementedError @dbus_property('b') def can_modify(self) -> bool: """If true adding and modifying connections is supported""" raise NotImplementedError def add_connection_profile( self, profile: ConnectionProfile, save_to_disk: bool = False, ) -> Tuple[str, None]: """Add new connection using the profile object. :param ConnectionProfile profile: Connection profile to update with. :param bool save_to_disk: Make changes permanent by saving updated values to disk. By default changes are temporary. (saved only to RAM) :return: Object path of new connection and None :rtype: Tuple[str, None] """ flags = 0 if save_to_disk: flags |= 0x1 else: flags |= 0x2 return ( (self.add_connection2(profile.to_dbus(), flags, {}))[0], None, ) class NetworkManagerVPNPluginInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.VPN.Plugin'): """Interface provided by VPN plugins""" @dbus_method('a{sa{sv}}') def connect( self, connection: NetworkManagerConnectionProperties, ) -> None: """Connect to described connection Interactive secrets requests not allowed. """ raise NotImplementedError @dbus_method('a{sa{sv}}a{sv}') def connect_interactive( self, connection: NetworkManagerConnectionProperties, details: Dict[str, Tuple[str, Any]], ) -> None: """Connect to described connection Interactive secrets requests allowed. (emits secrets_required signal) """ raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}', result_signature='s', ) def need_secrets( self, settings: NetworkManagerConnectionProperties, ) -> str: """Asks plugin if connection will require secrets :return: Setting name that requires secrets """ raise NotImplementedError @dbus_method() def disconnect( self, ) -> None: """Disconnect from VPN""" raise NotImplementedError @dbus_method('a{sv}') def set_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set generic connection details""" raise NotImplementedError @dbus_method('a{sv}') def set_ip4_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv4 settings""" raise NotImplementedError @dbus_method('a{sv}') def set_ip6_config( self, config: Dict[str, Tuple[str, Any]], ) -> None: """Set IPv6 settings""" raise NotImplementedError @dbus_method('s') def set_failure( self, reason: str, ) -> None: """Set the plugin failure reason""" raise NotImplementedError @dbus_method('a{sa{sv}}') def new_secrets( self, connection: NetworkManagerConnectionProperties, ) -> None: """Called in response to secrets_required signal param: Describes the connection including the new secrets """ raise NotImplementedError @dbus_property('u') def state(self) -> int: """VPN state See :py:class:`VpnState` """ raise NotImplementedError class NetworkManagerWifiP2PPeerInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager.WifiP2PPeer'): """Interface of a peer in Wi-Fi P2P connection""" @dbus_property('s') def name(self) -> str: """Device name""" raise NotImplementedError @dbus_property('u') def flags(self) -> int: """Flags describing capabilities of the point See :py:class:`AccessPointCapabilities` """ raise NotImplementedError @dbus_property('s') def manufacturer(self) -> str: """Manufacturer of the Wi-Fi P2P peer.""" raise NotImplementedError @dbus_property('s') def model(self) -> str: """Peer model""" raise NotImplementedError @dbus_property('s') def model_number(self) -> str: """Peer model number""" raise NotImplementedError @dbus_property('s') def serial(self) -> str: """Peer serial""" raise NotImplementedError @dbus_property('ay') def wfd_i_es(self) -> bytes: """Wi-Fi Display Information Elements of the peer""" raise NotImplementedError @dbus_property('y') def strength(self) -> int: """Current signal quality of the peer, in percent.""" raise NotImplementedError @dbus_property('i') def last_seen(self) -> int: """Timestamp in CLOCK_BOOTTIME seconds since last seen in scan Value of -1 means that the point was never found in scans. """ raise NotImplementedError class NetworkManagerInterface( DbusInterfaceCommon, interface_name='org.freedesktop.NetworkManager'): """Main network manager interface""" @dbus_method('u') def reload( self, flags: int = 0x0, ) -> None: """Reload NetworkManager configuration Flags control what to reload: * 0x0 everything * 0x1 NetworkManager.conf * 0x2 DNS configuration * 0x4 Restart DNS plugin :param flags: Reload what? """ raise NotImplementedError @dbus_method( result_signature='ao', ) def get_devices( self, ) -> List[str]: """Get list of device object paths known""" raise NotImplementedError @dbus_method( result_signature='ao', ) def get_all_devices( self, ) -> List[str]: """Get list of device object paths with placeholders""" raise NotImplementedError @dbus_method( input_signature='s', result_signature='o', ) def get_device_by_ip_iface( self, iface: str, ) -> str: """Get device object path by interface name""" raise NotImplementedError @dbus_method( input_signature='ooo', result_signature='o', ) def activate_connection( self, connection: str = '/', device: str = '/', specific_object: str = '/', ) -> str: """Activate the connection. :return: Activated connection object path. """ raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}oo', result_signature='oo', ) def add_and_activate_connection( self, connection: NetworkManagerConnectionProperties, device: str, specific_object: str, ) -> Tuple[str, str]: """Add a new connection and activate""" raise NotImplementedError @dbus_method( input_signature='a{sa{sv}}ooa{sv}', result_signature='ooa{sv}', ) def add_and_activate_connection2( self, connection: NetworkManagerConnectionProperties, device: str, specific_object: str, options: Dict[str, Tuple[str, Any]], ) -> Tuple[str, str, Dict[str, Tuple[str, Any]]]: """Add a new connection and activate""" raise NotImplementedError @dbus_method('o') def deactivate_connection( self, active_connection: str, ) -> None: """Deactivate connection by given path""" raise NotImplementedError @dbus_method('b') def sleep( self, sleep: bool, ) -> None: """Intended for system suspend/resume tracking not user""" raise NotImplementedError @dbus_method('b') def enable( self, enable: bool, ) -> None: """Disables all networking when set to false""" raise NotImplementedError @dbus_method( result_signature='a{ss}', ) def get_permissions( self, ) -> Dict[str, str]: """Returns the permissions of caller""" raise NotImplementedError @dbus_method('ss') def set_logging( self, level: str, domains: str, ) -> None: """Set logging verbosity and which operations are logged""" raise NotImplementedError @dbus_method( result_signature='ss', ) def get_logging( self, ) -> Tuple[str, str]: """Get current logging settings""" raise NotImplementedError @dbus_method( result_signature='u', ) def check_connectivity( self, ) -> int: """Get current connectivity state See :py:class:`NetworkManagerConnectivityState` """ raise NotImplementedError @dbus_method( result_signature='u', method_name='State', ) def get_state( self, ) -> int: """Get current NetworkManager state See :py:class:`NetworkManagerState` """ raise NotImplementedError @dbus_method( input_signature='aouu', result_signature='o', ) def checkpoint_create( self, devices: List[str], rollback_timeout: int, flags: int, ) -> str: """Create configuration checkpoint for given devices :return: New checkpoint object path """ raise NotImplementedError @dbus_method('o') def checkpoint_destroy( self, checkpoint: str, ) -> None: """Destroy given checkpoint""" raise NotImplementedError @dbus_method( input_signature='o', result_signature='a{su}', ) def checkpoint_rollback( self, checkpoint: str, ) -> Dict[str, int]: """Use given checkpoint to rollback configuration""" raise NotImplementedError @dbus_method('ou') def checkpoint_adjust_rollback_timeout( self, checkpoint: str, add_timeout: int, ) -> None: """Adjust checkpoint rollback timeout""" raise NotImplementedError @dbus_property('ao') def devices(self) -> List[str]: """List of all current devices""" raise NotImplementedError @dbus_property('ao') def all_devices(self) -> List[str]: """List of all current and un-realized devices""" raise NotImplementedError @dbus_property('ao') def checkpoints(self) -> List[str]: """List of all checkpoint objects""" raise NotImplementedError @dbus_property('b') def networking_enabled(self) -> bool: """Whether networking enabled or not""" raise NotImplementedError @dbus_property('b') def wireless_enabled(self) -> bool: """Whether wireless enabled or not""" raise NotImplementedError @dbus_property('b') def wireless_hardware_enabled(self) -> bool: """Whether wireless hardware enabled with RF kill switch""" raise NotImplementedError @dbus_property('b') def wwan_enabled(self) -> bool: """Whether mobile broadband devices enabled""" raise NotImplementedError @dbus_property('b') def wwan_hardware_enabled(self) -> bool: """Whether mobile hardware devices enabled with RF kill switch""" raise NotImplementedError @dbus_property('b') def wimax_enabled(self) -> bool: raise NotImplementedError @dbus_property('ao') def active_connections(self) -> List[str]: """List of active connection paths""" raise NotImplementedError @dbus_property('o') def primary_connection(self) -> str: """Object path for primary connection""" raise NotImplementedError @dbus_property('s') def primary_connection_type(self) -> str: """Primary connection type""" raise NotImplementedError @dbus_property('u') def metered(self) -> int: """Primary connection metered status See :py:class:`DeviceMetered` """ raise NotImplementedError @dbus_property('o') def activating_connection(self) -> str: """Primary connection activating connection""" raise NotImplementedError @dbus_property('b') def startup(self) -> bool: """Whether NetworkManager is still activating""" raise NotImplementedError @dbus_property('s') def version(self) -> str: """NetworkManager version""" raise NotImplementedError @dbus_property('au') def capabilities(self) -> List[int]: """NetworkManager capabilities * 1 Team devices * 2 OpenVSwitch """ raise NotImplementedError @dbus_property('u') def state(self) -> int: """Overall state of NetworkManager See :py:class:`NetworkManagerState` """ raise NotImplementedError @dbus_property('u') def connectivity(self) -> int: """Overall state of connectivity See :py:class:`NetworkManagerConnectivityState` """ raise NotImplementedError @dbus_property('b') def connectivity_check_available(self) -> bool: raise NotImplementedError @dbus_property('b') def connectivity_check_enabled(self) -> bool: """Whether the connectivity checking is enabled Can be written. """ raise NotImplementedError @dbus_property('s') def connectivity_check_uri(self) -> str: """URI that network manager will hit to check internet connection""" raise NotImplementedError @dbus_property('a{sv}') def global_dns_configuration(self) -> Dict[str, Tuple[str, Any]]: """Global DNS connection settings""" raise NotImplementedError def add_and_activate_connection_profile( self, profile: ConnectionProfile, device_path: str = '/', specific_object: str = '/', ) -> Tuple[str, str]: """Adds new connection using the profile object as template. :param ConnectionProfile profile: Connection profile to update with. :param str device_path: Object path of device to be activated using the given connection :param str specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used. :return: Object path of new connection and path of active connection. :rtype: Tuple[str, str] """ return self.add_and_activate_connection( profile.to_dbus(), device_path, specific_object, ) python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/objects.py000066400000000000000000001023041442124064700267700ustar00rootroot00000000000000 # SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from typing import List, Optional from sdbus.sd_bus_internals import SdBus from .interfaces_devices import ( NetworkManagerDeviceBluetoothInterface, NetworkManagerDeviceBondInterface, NetworkManagerDeviceBridgeInterface, NetworkManagerDeviceGenericInterface, NetworkManagerDeviceInterface, NetworkManagerDeviceIPTunnelInterface, NetworkManagerDeviceMacsecInterface, NetworkManagerDeviceMacvlanInterface, NetworkManagerDeviceModemInterface, NetworkManagerDeviceOlpcMeshInterface, NetworkManagerDeviceOvsBridgeInterface, NetworkManagerDeviceOvsPortInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceTeamInterface, NetworkManagerDeviceTunInterface, NetworkManagerDeviceVethInterface, NetworkManagerDeviceVlanInterface, NetworkManagerDeviceVrfInterface, NetworkManagerDeviceVxlanInterface, NetworkManagerDeviceWifiP2PInterface, NetworkManagerDeviceWiredInterface, NetworkManagerDeviceWireGuardInterface, NetworkManagerDeviceWirelessInterface, NetworkManagerPPPInterface, ) from .interfaces_other import ( NetworkManagerAccessPointInterface, NetworkManagerCheckpointInterface, NetworkManagerConnectionActiveInterface, NetworkManagerDHCP4ConfigInterface, NetworkManagerDHCP6ConfigInterface, NetworkManagerDnsManagerInterface, NetworkManagerInterface, NetworkManagerIP4ConfigInterface, NetworkManagerIP6ConfigInterface, NetworkManagerSecretAgentManagerInterface, NetworkManagerSettingsConnectionInterface, NetworkManagerSettingsInterface, NetworkManagerVPNConnectionInterface, NetworkManagerWifiP2PPeerInterface, ) from .settings.profile import ConnectionProfile from .types import NetworkManagerConnectionProperties NETWORK_MANAGER_SERVICE_NAME = 'org.freedesktop.NetworkManager' class NetworkManager(NetworkManagerInterface): """Network Manger main object Implements :py:class:`NetworkManagerInterface` Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager', bus) class NetworkManagerAgentManager(NetworkManagerSecretAgentManagerInterface): """NetworkManager secrets manager Implements :py:class:`NetworkManagerSecretAgentManagerInterface`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/AgentManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/AgentManager', bus) class NetworkManagerDnsManager(NetworkManagerDnsManagerInterface): """NetworkManager DNS manager Implements :py:class:`NetworkManagerDnsManagerInterface`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/DnsManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/DnsManager', bus) class NetworkManagerSettings(NetworkManagerSettingsInterface): """NetworkManager settings Implements :py:class:`NetworkManagerSettingsInterface`. Service name ``'org.freedesktop.NetworkManager'`` and object path ``/org/freedesktop/NetworkManager/DnsManager`` is predetermined. """ def __init__(self, bus: Optional[SdBus] = None) -> None: """ :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, '/org/freedesktop/NetworkManager/Settings', bus) def get_connections_by_id(self, connection_id: str) -> List[str]: """Helper method to get a list of connection profile paths which use the given connection identifier. :param str connection_id: The connection identifier of the connections, e.g. "Wired connection 1" :return: List of connection profile paths using the given identifier. """ connection_paths_with_matching_id = [] for connection_path in self.connections: profile = NetworkConnectionSettings(connection_path) # profile.get_settings()["connection"]["id"][1] gives the id value: if profile.get_settings()["connection"]["id"][1] == connection_id: connection_paths_with_matching_id.append(connection_path) return connection_paths_with_matching_id def get_settings_by_uuid( self, connection_uuid: str ) -> NetworkManagerConnectionProperties: """Helper to get a nested settings dict of a connection profile by uuid. :param str connection_uuid: The connection uuid of the connection profile :return: Nested dictionary of all settings of the given connection profile """ connection = self.get_connection_by_uuid(connection_uuid) return NetworkConnectionSettings(connection).get_settings() def delete_connection_by_uuid(self, connection_uuid: str) -> None: """Helper to delete a connection profile identified by the connection uuid. :param str connection_uuid: The connection uuid of the connection profile """ conn_dbus_path = self.get_connection_by_uuid(connection_uuid) NetworkConnectionSettings(conn_dbus_path).delete() class NetworkConnectionSettings( NetworkManagerSettingsConnectionInterface): """Setting of specific connection Implements :py:class:`NetworkManagerSettingsConnectionInterface` """ def __init__(self, settings_path: str, bus: Optional[SdBus] = None) -> None: """ :param settings_path: D-Bus path to settings object. \ Usually obtained from \ :py:attr:`NetworkManagerDeviceInterface.active_connection` :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, settings_path, bus) def connection_profile(self) -> ConnectionProfile: """Return a ConnectionProfile object containing all profile settings :return: Nested dataclass containing all settings of the profile """ return ConnectionProfile.from_dbus(self.get_settings()) class NetworkDeviceGeneric( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceGenericInterface): """Generic device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceGenericInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWired( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceWiredInterface): """Ethernet device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceWiredInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWireless( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceWirelessInterface): """WiFi device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceWirelessInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBluetooth( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceBluetoothInterface): """Bluetooth device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceBluetoothInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBond( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceBondInterface): """Bond device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceBondInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceBridge( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceBridgeInterface): """Bridge device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceBridgeInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceIpTunnel( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceIPTunnelInterface): """Generic device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceIPTunnelInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceMacsec( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceMacsecInterface): """Macsec device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceMacsecInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceMacvlan( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceMacvlanInterface): """Macvlan device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceMacvlanInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceModem( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceModemInterface): """Generic device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceModemInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOlpcMesh( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceOlpcMeshInterface): """OLPC wireless mesh device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceOlpcMeshInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOpenVSwitchBridge( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceOvsBridgeInterface): """Open vSwitch bridge device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceOvsBridgeInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceOpenVSwitchPort( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceOvsPortInterface): """Open vSwitch port device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceOvsPortInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceTeam( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceTeamInterface): """Team device (special Bond device for NetworkManager) Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceTeamInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceTun( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceTunInterface): """TUN device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceTunInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVeth( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceVethInterface): """Virtual Ethernet device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceVethInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVlan( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceVlanInterface): """VLAN device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceVlanInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVrf( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceVrfInterface): """VRF (virtual routing) device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceVrfInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceVxlan( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceVxlanInterface): """VXLAN device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceVxlanInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWifiP2P( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceWifiP2PInterface): """Wifi Peer-to-Peer (P2P) device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceWifiP2PInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDeviceWireGuard( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerDeviceWireGuardInterface): """Generic device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerDeviceWireGuardInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class NetworkDevicePPP( NetworkManagerDeviceInterface, NetworkManagerDeviceStatisticsInterface, NetworkManagerPPPInterface): """PPP device Implements :py:class:`NetworkManagerDeviceInterface`, \ :py:class:`NetworkManagerDeviceStatisticsInterface` and \ :py:class:`NetworkManagerPPPInterface` """ def __init__(self, device_path: str, bus: Optional[SdBus] = None) -> None: """ :param device_path: D-Bus path to device object. \ Obtained from \ :py:meth:`NetworkManagerInterface.get_devices` or \ :py:meth:`NetworkManagerInterface.get_device_by_ip_iface`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, device_path, bus) class ActiveConnection(NetworkManagerConnectionActiveInterface): """Active connection object Implements :py:class:`NetworkManagerConnectionActiveInterface` """ def __init__(self, connection_path: str, bus: Optional[SdBus] = None) -> None: """ :param connection_path: D-Bus path to connection object. \ Obtained from \ :py:meth:`NetworkManagerDeviceInterface.active_connection`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, connection_path, bus) class ActiveVPNConnection( ActiveConnection, NetworkManagerVPNConnectionInterface): """Active VPN connection object Implements :py:class:`NetworkManagerConnectionActiveInterface` and :py:class:`NetworkManagerVPNConnectionInterface` """ ... class IPv4Config(NetworkManagerIP4ConfigInterface): """IPv4 configuration interface Implements :py:class:`NetworkManagerIP4ConfigInterface` """ def __init__(self, ip4_path: str, bus: Optional[SdBus] = None) -> None: """ :param ip4_path: D-Bus path to IPv4 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterface.ip4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, ip4_path, bus) class IPv6Config(NetworkManagerIP6ConfigInterface): """IPv6 configuration interface Implements :py:class:`NetworkManagerIP6ConfigInterface` """ def __init__(self, ip6_path: str, bus: Optional[SdBus] = None) -> None: """ :param ip6_path: D-Bus path to IPv6 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterface.ip4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, ip6_path, bus) class DHCPv4Config(NetworkManagerDHCP4ConfigInterface): """DHCPv4 configuration interface Implements :py:class:`NetworkManagerDHCP4ConfigInterface` """ def __init__(self, dhcp4_path: str, bus: Optional[SdBus] = None) -> None: """ :param dhcp4_path: D-Bus path to DHCPv4 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterface.dhcp4_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, dhcp4_path, bus) class DHCPv6Config(NetworkManagerDHCP6ConfigInterface): """DHCPv6 configuration interface Implements :py:class:`NetworkManagerDHCP6ConfigInterface` """ def __init__(self, dhcpv6_path: str, bus: Optional[SdBus] = None) -> None: """ :param dhcpv6_path: D-Bus path to DHCPv6 config object. \ Obtained from \ :py:attr:`NetworkManagerDeviceInterface.dhcp6_config`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, dhcpv6_path, bus) class AccessPoint(NetworkManagerAccessPointInterface): """Access Point (WiFi point) object Implements :py:class:`NetworkManagerAccessPointInterface` """ def __init__(self, point_path: str, bus: Optional[SdBus] = None) -> None: """ :param point_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWirelessInterface.access_points`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, point_path, bus) class WiFiP2PPeer(NetworkManagerWifiP2PPeerInterface): """WiFi peer object Implements :py:class:`NetworkManagerWifiP2PPeerInterface` """ def __init__(self, peer_path: str, bus: Optional[SdBus] = None) -> None: """ :param peer_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWifiP2PInterface.peers`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, peer_path, bus) class ConfigCheckpoint(NetworkManagerCheckpointInterface): """Configuration checkpoint interface Implements :py:class:`NetworkManagerCheckpointInterface` """ def __init__(self, checkpoint_path: str, bus: Optional[SdBus] = None) -> None: """ :param checkpoint_path: D-Bus path to access point object. \ Obtained from \ :py:attr:`NetworkManagerDeviceWifiP2PInterface.checkpoint_create`. :param bus: You probably want to set default bus to system bus \ or pass system bus directly. """ super().__init__( NETWORK_MANAGER_SERVICE_NAME, checkpoint_path, bus) python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/py.typed000066400000000000000000000000001442124064700264520ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/settings000077700000000000000000000000001442124064700363742../../sdbus_async/networkmanager/settings/ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/sdbus_block/networkmanager/types.py000077700000000000000000000000001442124064700362032../../sdbus_async/networkmanager/types.pyustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/setup.py000066400000000000000000000047241442124064700211700ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, 2021 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from setuptools import setup with open('./README.md') as f: long_description = f.read() setup( name='sdbus-networkmanager', description=('NetworkManager binds for sdbus.'), long_description=long_description, long_description_content_type='text/markdown', version='2.0rc2', url='https://github.com/igo95862/python-sdbus', author='igo95862', author_email='igo95862@yandex.ru', license='LGPL-2.1-or-later', keywords='dbus networkmanager networking linux freedesktop', project_urls={ 'Documentation': 'https://python-sdbus.readthedocs.io/en/latest/', 'Source': 'https://github.com/igo95862/python-sdbus/', 'Tracker': 'https://github.com/igo95862/python-sdbus/issues/', }, classifiers=[ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', ( 'License :: OSI Approved :: ' 'GNU Lesser General Public License v2 or later (LGPLv2+)' ), 'Operating System :: POSIX :: Linux', 'Programming Language :: Python :: 3 :: Only', 'Topic :: Software Development :: Libraries :: Python Modules', ], packages=['sdbus_async.networkmanager', 'sdbus_async.networkmanager.settings', 'sdbus_block.networkmanager', 'sdbus_block.networkmanager.settings', ], package_data={ 'sdbus_async.networkmanager': [ 'py.typed', ], 'sdbus_block.networkmanager': [ 'py.typed', ], }, python_requires='>=3.7', install_requires=[ 'sdbus>=0.8rc2', ], ) python-sdbus-networkmanager-2.0rc2/tests/000077500000000000000000000000001442124064700206115ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/tests/__init__.py000066400000000000000000000015071442124064700227250ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2022 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA python-sdbus-networkmanager-2.0rc2/tests/async/000077500000000000000000000000001442124064700217265ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/tests/async/test_get_settings.py000077500000000000000000000117171442124064700260500ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later import asyncio import unittest import pytest import sdbus from sdbus_async.networkmanager import ( ConnectionProfile, NetworkManagerSettings as SettingsManager, NetworkManagerConnectionProperties as ConnectionProfileDict, ) def profile_with_autoconnect_set_to(autoconnect: bool) -> ConnectionProfile: dummy_profile: ConnectionProfileDict = { "connection": { "id": ("s", 'DummyConnection'), "uuid": ("s", '16ea7af1-0e35-4036-831e-ced975f48510'), "type": ("s", "dummy"), "autoconnect": ("b", autoconnect), "interface-name": ("s", "dummy-notused0"), }, } profile_from_dbus_dict = ConnectionProfile.from_dbus(dummy_profile) # Assert that ConnectionProfile.from_dbus parsed autoconnect correctly: assert profile_from_dbus_dict.connection.autoconnect is autoconnect return profile_from_dbus_dict def set_sdbus_default_bus() -> None: sdbus.set_default_bus(sdbus.sd_bus_open_system()) async def get_settings_by_networkmanager( profile: ConnectionProfileDict, ) -> ConnectionProfileDict: """Add a connection and return the settings of NetworkManager Uses the helper method get_gettings_by_uuid() which uses get_settings() Requires access and permissions to access a running NetworkManager. The added (dummy) connection is not saved and deleted immediately""" manager = SettingsManager() # Temporarily add the new Wifi connection to NetworkManager: await manager.add_connection_unsaved(profile) # Get the settings of the temporary connection from NetworkManager: uuid = profile["connection"]["uuid"][1] connection_profile_dict = await manager.get_settings_by_uuid(uuid) # Remove the temporay connection (now that we have read its settings): await manager.delete_connection_by_uuid(uuid) return connection_profile_dict @pytest.mark.asyncio async def test_autoconnect_false_returned_by_networkmanager() -> None: """Test get_settings_by_uuid() and check that autoconnect = False is set""" set_sdbus_default_bus() # Set autoconnect = ("b", False) and expect it to be returned by NM: profile_test = profile_with_autoconnect_set_to(autoconnect=False).to_dbus() profile_from_manager = await get_settings_by_networkmanager(profile_test) # Assert that NetworkManager did return autoconnect=False (default is True) unittest.TestCase().assertTupleEqual( profile_from_manager["connection"]["autoconnect"], ("b", False) ) @pytest.mark.asyncio async def test_autoconnect_true_not_returned_by_networkmanager() -> None: """Check autoconnect=True (is default) is not returned by get_settings()""" set_sdbus_default_bus() # Set autoconnect = ("b", True) and expect to not be returned by NM: # (NetworkManager does not return a property if it has the default value) profile_test = profile_with_autoconnect_set_to(autoconnect=True).to_dbus() unittest.TestCase().assertTupleEqual( profile_test["connection"]["autoconnect"], ("b", True) ) # Assert that NetworkManager did not return autoconnect (default is True) profile_from_manager = await get_settings_by_networkmanager(profile_test) assert "autoconnect" not in profile_from_manager["connection"] def test_autoconnect_true_returned_by_settings_dict_when_requested() -> None: """to_settings_dict(defaults=True) returns autoconnect=True (is default)""" profile_from_dbus_dict = profile_with_autoconnect_set_to(True) settings_dict = profile_from_dbus_dict.to_settings_dict(defaults=True) assert settings_dict["connection"]["autoconnect"] is True def test_autoconnect_true_not_returned_by_to_settings_dict() -> None: """to_settings_dict(defaults=False) does not return autoconnect=True""" # Like checked by test_autoconnect_true_not_returned_by_networkmanager() # above (which checks that get_settings) does not return autoconnect=True # (because it is the default), test the same for .to_settings_dict(): profile_from_dbus_dict = profile_with_autoconnect_set_to(True) settings_dict = profile_from_dbus_dict.to_settings_dict(defaults=False) # Assert that networkmanager did not return autoconnect (default is True) assert "autoconnect" not in settings_dict["connection"] async def check_to_settings_dict_profile_eqal_to_from_settings_dict() -> None: """Async main function to run all tests when not run by pytest""" """The tests can be run by pytest (and from IDEs by running this module)""" set_sdbus_default_bus() await test_autoconnect_false_returned_by_networkmanager() await test_autoconnect_true_not_returned_by_networkmanager() test_autoconnect_true_returned_by_settings_dict_when_requested() test_autoconnect_true_not_returned_by_to_settings_dict() if __name__ == "__main__": """Main function to run all tests when not run by pytest""" asyncio.run(check_to_settings_dict_profile_eqal_to_from_settings_dict()) python-sdbus-networkmanager-2.0rc2/tests/settings/000077500000000000000000000000001442124064700224515ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/tests/settings/test_from_dbus_async.py000077500000000000000000000025661442124064700272530ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later from sdbus_async.networkmanager import ( ConnectionProfile, ) def test_connection_profile_ipv4_from_dbus() -> None: """Parse connection and ipv4 settings from dbus using ConnectionProfile""" profile = ConnectionProfile.from_dbus( { "connection": { "id": ("s", 'Test for the connection id'), "uuid": ("s", '1ba25035-970b-4c4a-bf3c-8c6cdf8ab5d0'), "type": ("s", "802-3-ethernet"), "autoconnect": ('b', True), }, 'ipv4': { 'address-data': ( 'aa{sv}', [{'address': ('s', '192.0.2.1'), 'prefix': ('u', 24)}], ) }, } ) assert profile.connection.connection_id == "Test for the connection id" assert profile.connection.uuid == "1ba25035-970b-4c4a-bf3c-8c6cdf8ab5d0" assert profile.connection.connection_type == "802-3-ethernet" assert profile.connection.autoconnect is True assert profile.ipv4 assert profile.ipv4.address_data assert profile.ipv4.address_data[0].address == "192.0.2.1" assert profile.ipv4.address_data[0].prefix == 24 if __name__ == "__main__": """The tests can be run by pytest (and from IDEs by running this module)""" test_connection_profile_ipv4_from_dbus() python-sdbus-networkmanager-2.0rc2/tests/settings/test_from_dict_async.py000077500000000000000000000062571442124064700272420ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later import asyncio import contextlib import sdbus import pytest from sdbus_async.networkmanager import ( ConnectionProfile, NetworkConnectionSettings, NetworkManagerSettings as SettingsManager, NmSettingsInvalidConnectionError, ) # All test coroutines will be treated as marked. def test_wifi_wpa_psk_simple_from_dict() -> ConnectionProfile: """Parse connection and ipv4 settings from dbus using ConnectionProfile""" profile = ConnectionProfile.from_settings_dict( { "connection": { "id": "WirelessWpaPskConnection", "type": "802-11-wireless", "uuid": "16ea7af1-0e35-4036-831e-ced975f48510", "autoconnect": False, }, "ipv4": {"method": "auto"}, "ipv6": {"method": "disabled"}, "802-11-wireless": { "security": "802-11-wireless-security", "ssid": b"CafeSSID", }, "802-11-wireless-security": {"key-mgmt": "wpa-psk"}, } ) assert profile.connection.connection_id == "WirelessWpaPskConnection" assert profile.connection.uuid == "16ea7af1-0e35-4036-831e-ced975f48510" assert profile.connection.connection_type == "802-11-wireless" assert profile.connection.autoconnect is False assert profile.ipv4 assert profile.ipv4.method == "auto" assert profile.ipv4.address_data is None assert profile.ipv6 assert profile.ipv6.method == "disabled" return profile async def delete_connection_by_uuid(nmset: SettingsManager, uuid: str) -> None: dpath = await nmset.get_connection_by_uuid(uuid) connection_settings = NetworkConnectionSettings(dpath) await connection_settings.delete() # @pytest_asyncio.fixture @pytest.mark.asyncio async def test_add_wifi_wpa_psk_simple_from_dict() -> None: """Test adding a wireless WPA PSK connection profile(unsaved) from dict""" profile = test_wifi_wpa_psk_simple_from_dict() # If we add many connections passing the same id, things get messy. Check: sdbus.set_default_bus(sdbus.sd_bus_open_system()) settings = SettingsManager() assert profile.connection.uuid with contextlib.suppress(NmSettingsInvalidConnectionError): await settings.get_connection_by_uuid(profile.connection.uuid) print(f"Deleting existing connection with {profile.connection.uuid}") await delete_connection_by_uuid(settings, profile.connection.uuid) await settings.add_connection_unsaved(profile.to_dbus()) await delete_connection_by_uuid(settings, profile.connection.uuid) if __name__ == "__main__": """The tests can be run by pytest (and from IDEs by running this module)""" test_wifi_wpa_psk_simple_from_dict() # Test using ConnectionProfile.from_dict() to create a ConnectionProfile # which can be used to add Wireless WPA PSK connection profile from dict # to a running NetworkManager. Requires access and permissions to access # a running NetworkManager. The added connection is not saved and deleted # immediately (and does not have autoconnect enabled): asyncio.run(test_add_wifi_wpa_psk_simple_from_dict()) python-sdbus-networkmanager-2.0rc2/tests/test_settings_profile.py000066400000000000000000000054301442124064700256040ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2022 igo95862 # This file is part of python-sdbus # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # This library 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 # Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from __future__ import annotations from unittest import TestCase from sdbus_async.networkmanager.settings import ConnectionProfile connection_dict = { 'connection': {'id': 'mlvd-wg', 'interface-name': 'mlvd-wg', 'timestamp': 150000, 'type': 'wireguard', 'uuid': 'uuid'}, 'ipv4': {'address-data': [{'address': '10.0.0.1', 'prefix': 32}], 'dns': [150000], 'dns-search': ['~'], 'method': 'manual'}, 'ipv6': {'addr-gen-mode': 1, 'address-data': [{'address': 'fc00:1', 'prefix': 128}], 'method': 'manual'}, 'wireguard': { 'peers': [ {'allowed-ips': ['::/0', '0.0.0.0/0'], 'endpoint': '1.1.1.1:51820', 'public-key': 'public_key'}]}} secret_dict = { 'connection': {}, 'ipv4': {}, 'ipv6': {}, 'proxy': {}, 'wireguard': { 'peers': [ {'public-key': 'public_key'} ], 'private-key': 'secret_key'}} class TestSettingsProfile(TestCase): def test_update(self) -> None: connection = ConnectionProfile.from_settings_dict(connection_dict) secrets = ConnectionProfile.from_settings_dict(secret_dict) connection.update(secrets) self.assertEqual(connection.wireguard.private_key, 'secret_key') def test_update_secrets(self) -> None: connection = ConnectionProfile.from_settings_dict(connection_dict) secrets = ConnectionProfile.from_settings_dict(secret_dict) connection_secret_update_generator = ( connection.update_secrets_generator() ) setting_name = next(connection_secret_update_generator) self.assertEqual(setting_name, 'wireguard') with self.assertRaises(StopIteration): connection_secret_update_generator.send(secrets) self.assertEqual(connection.wireguard.private_key, 'secret_key') python-sdbus-networkmanager-2.0rc2/tools/000077500000000000000000000000001442124064700206075ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/tools/generate-settings-dataclasses-jinja.py000066400000000000000000000243221442124064700301720ustar00rootroot00000000000000#!/usr/bin/env python # SPDX-License-Identifier: LGPL-2.1-or-later # Gerating nm-settings-docs-dbus.xml from NetworkManager source code # 1. meson setup \ # -Dselinux=false \ # -Dqt=false \ # -Dintrospection=true \ # -Ddocs=true \ # build # 2. cd build # 3. ninja man/nm-settings-docs-dbus.xml from __future__ import annotations import builtins import keyword from argparse import ArgumentParser from functools import cached_property from itertools import dropwhile from pathlib import Path from re import Pattern from re import compile as regex_compile from textwrap import fill from typing import List, Optional, Set from xml.etree.ElementTree import Element, parse from jinja2 import Environment, FileSystemLoader, StrictUndefined dbus_to_python_extra_typing_imports = { "as": ("List", ), "au": ("List", ), "a{ss}": ("Dict", ), "aa{sv}": ("List", "Tuple", "Any"), "aau": ("List", ), "aay": ("List", ) } dbus_to_python_type_map = { "b": "bool", "s": "str", "i": "int", "u": "int", "t": "int", "x": "int", "y": "int", "as": "List[str]", "au": "List[int]", "ay": "bytes", "a{ss}": "Dict[str, str]", "aa{sv}": "List[Tuple[str, Any]]", "aau": "List[List[int]]", "aay": "List[bytes]", } dbus_name_type_map = { 'array of array of uint32': 'aau', 'array of byte array': 'aay', 'array of legacy IPv6 address struct': 'a(ayuay)', 'array of legacy IPv6 address struct (a(ayuay))': 'a(ayuay)', 'array of legacy IPv6 route struct': 'a(ayuayu)', 'array of legacy IPv6 route struct (a(ayuayu))': 'a(ayuayu)', 'array of string': 'as', 'array of strings': 'as', 'array of uint32': 'au', 'array of vardict': 'aa{sv}', "array of 'a{sv}'": 'aa{sv}', # wireguard.peers uses this, fix NM upstream 'boolean': 'b', 'byte': 'y', 'byte array': 'ay', 'dict of string to string': 'a{ss}', 'int32': 'i', 'int64': 'x', 'string': 's', 'uint32': 'u', 'uint64': 't', } python_name_replacements = { 'type': 'connection_type', 'id': 'pretty_id', } array_of_vardicts_python_classes: dict[str, str] = { 'peers': 'WireguardPeers', 'vlans': 'Vlans', 'address-data': 'AddressData', 'route-data': 'RouteData', 'routing-rules': 'RoutingRules', 'vfs': 'Vfs', 'qdiscs': 'Qdiscs', 'tfilters': 'Tfilters', 'link-watchers': 'LinkWatchers', } setting_name_replacement: dict[str, str] = { 'x': 'eapol', } def must_replace_name(name: str) -> bool: return (keyword.iskeyword(name) or keyword.issoftkeyword(name) or hasattr(builtins, name)) class NmSettingPropertyIntrospection: def __init__(self, name: str, description: str, name_upper: str, dbus_type: str, parent: NmSettingsIntrospection, default: Optional[str] = None, ) -> None: self.name = name self.description = description self.name_upper = name_upper self.python_name = name_upper.lower() self.dbus_type = dbus_type self.default = default if must_replace_name(self.python_name): self.python_name = (f"{parent.name_upper.lower()}" f"_{self.python_name}") extra_typing = dbus_to_python_extra_typing_imports.get(dbus_type) if extra_typing is not None: parent.properties_want_imports.update(extra_typing) @cached_property def python_type(self) -> str: if self.dbus_type == 'aa{sv}': return f"List[{array_of_vardicts_python_classes[self.name]}]" return dbus_to_python_type_map[self.dbus_type] @cached_property def python_inner_class(self) -> Optional[str]: return array_of_vardicts_python_classes.get(self.name) class NmSettingsIntrospection: def __init__(self, name: str, description: str, name_upper: str, ) -> None: self.name = name self.description = description self.name_upper = name_upper self.properties_want_imports = {'Optional'} self.properties: List[NmSettingPropertyIntrospection] = [] @cached_property def typing_imports(self) -> Set[str]: typing_imports: Set[str] = self.properties_want_imports.copy() return typing_imports @cached_property def python_class_name(self) -> str: camel_case = ''.join( map(str.title, self.snake_name.split('_')) ) return camel_case + 'Settings' @cached_property def snake_name(self) -> str: underscore_name = self.name.replace('-', '_') no_first_digits_name = ''.join( dropwhile( lambda s: not str.isalpha(s), underscore_name)) return setting_name_replacement.get( no_first_digits_name, no_first_digits_name, ) @cached_property def datatypes_imports(self) -> list[str]: datatypes_found: list[str] = [] for x in self.properties: if (datatype := x.python_inner_class) is not None: datatypes_found.append(datatype) return datatypes_found @cached_property def is_optional_setting(self) -> bool: if self.name == 'connection': return False return True @cached_property def secret_fields(self) -> Set[str]: all_fields: Set[str] = set() possible_secret_fields: Set[str] = set() for x in self.properties: if (x.python_name.endswith('_flags') and x.python_type == 'int' and x.description.startswith('Flags indicating')): possible_secret_fields.add( x.python_name.removesuffix('_flags')) else: all_fields.add(x.python_name) return all_fields.intersection(possible_secret_fields) def extract_docbook_paragraphs(docbook_node: Element) -> List[str]: return [x.text for x in docbook_node] def extract_description_paragraph(description_node: Element) -> str: return description_node.text def extract_and_format_option_description(node: Element) -> str: formatted_paragraphs: list[str] = [] paragraphs: list[str] = [] description = 'Not documented' for doc_node in node: if doc_node.tag == 'description-docbook': paragraphs.extend(extract_docbook_paragraphs(doc_node)) elif doc_node.tag == 'description': description = extract_description_paragraph(doc_node) elif doc_node.tag == 'deprecated': ... elif doc_node.tag == 'deprecated-docbook': ... else: raise ValueError("Unknown doc node", doc_node.tag) if paragraphs: first_para = paragraphs.pop(0) else: first_para = description formatted_paragraphs.append( fill( first_para, width=72, subsequent_indent=' ', ) ) for para in paragraphs: formatted_paragraphs.append( fill( para, width=72, initial_indent=' ', subsequent_indent=' ', ) ) return '\n\n'.join(formatted_paragraphs) def convert_property(node: Element, parent: NmSettingsIntrospection ) -> Optional[NmSettingPropertyIntrospection]: options = node.attrib.copy() try: unconverted_type = options.pop('type') except KeyError: return None try: dbus_type = dbus_name_type_map[unconverted_type] except KeyError: dbus_type = dbus_name_type_map[unconverted_type.split('(')[1][:-1]] options['dbus_type'] = dbus_type options['description'] = extract_and_format_option_description(node) new_property = NmSettingPropertyIntrospection(**options, parent=parent) try: new_property.python_type except KeyError: return None return new_property def generate_introspection(root: Element) -> List[NmSettingsIntrospection]: settings_introspection: List[NmSettingsIntrospection] = [] for setting_node in root: setting = NmSettingsIntrospection(**setting_node.attrib) for x in setting_node: new_property = convert_property(x, setting) if new_property is not None: setting.properties.append(new_property) settings_introspection.append(setting) return settings_introspection def main( settings_xml_path: Path, settings_regex_filter: Optional[Pattern] = None, ) -> None: jinja_env = Environment( loader=FileSystemLoader(Path('./tools/jinja_templates/')), undefined=StrictUndefined, ) settings_template = jinja_env.get_template('setting.py.jinja2') tree = parse(settings_xml_path) all_settings = sorted( generate_introspection(tree.getroot()), key=lambda x: x.snake_name, ) settings_dir = Path('./sdbus_async/networkmanager/settings/') for setting in all_settings: if settings_regex_filter is not None: if not settings_regex_filter.match(setting.snake_name): continue setting_py_file = settings_dir / (setting.snake_name + '.py') with open(setting_py_file, mode='w') as f: f.write(settings_template.render(setting=setting)) profile_template = jinja_env.get_template('profile.py.jinja2') with open(settings_dir / 'profile.py', mode='w') as f: f.write(profile_template.render(all_settings=all_settings)) init_template = jinja_env.get_template('__init__.py.jinja2') with open(settings_dir / '__init__.py', mode='w') as f: f.write(init_template.render(all_settings=all_settings)) docs_template = jinja_env.get_template('profile_settings.rst.jinja2') with open('./docs/profile_settings.rst', mode='w') as f: f.write(docs_template.render(all_settings=all_settings)) if __name__ == '__main__': arg_parser = ArgumentParser() arg_parser.add_argument( 'settings_xml_path', type=Path, default=Path('./nm-settings-docs-dbus.xml'), ) arg_parser.add_argument( '--settings-regex-filter', type=regex_compile, ) args = arg_parser.parse_args() main(**vars(args)) python-sdbus-networkmanager-2.0rc2/tools/generate-settings-dataclasses.py000077500000000000000000000352251442124064700271100ustar00rootroot00000000000000#!/usr/bin/env python # Based on NetworkManager-1.39.2/tools/generate-docs-nm-settings-docs-merge.py # SPDX-License-Identifier: LGPL-2.1-or-later import collections import io import os import textwrap import xml.etree.ElementTree as ElementTree from argparse import ArgumentParser from pathlib import Path from typing import Any, Dict, List, Optional, OrderedDict, Tuple dbus_type_name_map = { "b": "bool", "s": "str", "i": "int", "u": "int", "t": "int", "x": "int", "y": "int", "as": "List[str]", "au": "List[int]", "ay": "bytes", "a{ss}": "Dict[str, str]", "aa{sv}": "List[Tuple[str, Any]]", "aau": "List[List[int]]", "aay": "List[bytes]", # Legacy types: "a(ayuay)": "array of legacy IPv6 address struct", "a(ayuayu)": "array of legacy IPv6 route struct", } dbus_name_type_map = { 'array of array of uint32': 'aau', 'array of byte array': 'aay', 'array of legacy IPv6 address struct': 'a(ayuay)', 'array of legacy IPv6 route struct': 'a(ayuayu)', 'array of string': 'as', 'array of uint32': 'au', 'array of vardict': 'aa{sv}', "array of 'a{sv}'": 'aa{sv}', # wireguard.peers uses this, fix NM upstream 'boolean': 'b', 'byte': 'y', 'byte array': 'ay', 'dict of string to string': 'a{ss}', 'int32': 'i', 'int64': 'x', 'string': 's', 'uint32': 'u', 'uint64': 't', } ############################################################################### # Order of the connection types(settings_classes) in the profile dataclass: _setting_name_order = [ "connection", "ipv4", "ipv6", "generic", "ethtool", "adsl", "bluetooth", "bond", "bond-port", "bridge", "bridge-port", "cdma", "dcb", "dummy", "802-3-ethernet", "gsm", "hostname", "802-1x", "infiniband", "ip-tunnel", "6lowpan", "macsec", "macvlan", "match", "802-11-olpc-mesh", "ovs-bridge", "ovs-dpdk", "ovs-external-ids", "ovs-interface", "ovs-patch", "ovs-port", "ppp", "pppoe", "proxy", "serial", "sriov", "tc", "team", "team-port", "tun", "user", "veth", "vlan", "vpn", "vrf", "vxlan", "wifi-p2p", "wimax", "wireguard", "802-11-wireless", "802-11-wireless-security", "wpan", ] # List of modules for which we must generate an import of typing.List list_modules = [ "bridge", "bridge_port", "dcb", "connection", "ethernet", "ieee802_1x", "ipv4", "ipv6", "match", "sriov", "tc", "team", "team_port", "user", "vlan", "vpn", "wireguard", "wireless", "wireless_security", ] # Order of special properties which must be first because they are not optional _property_name_order = [ "connection.id", "connection.type", "connection.uuid", ] def _property_name_order_idx(name: str) -> int: """Return the sort index for the given connection setting property""" try: return _property_name_order.index(name) except ValueError: # Properties not in _property_name_order are sorted last and then by their name return len(_property_name_order) def key_fcn_property_name(n1: str) -> Tuple[int, str]: """key function for sorted(), used to sort connection properties""" return (_property_name_order_idx(n1), n1) def _setting_name_order_idx(name: str) -> int: """Return the sort index for the given connection type(settings_class)""" try: return _setting_name_order.index(name) except ValueError: return len(_setting_name_order) def key_fcn_setting_name(n1: str) -> Tuple[int, str]: """key function for sorted(), used to sort the settings_classes(connection types)""" return (_setting_name_order_idx(n1), n1) def iter_keys_of_dicts( dicts: List[Dict[str, Any]], key: Optional[Any] = None, prefix: Optional[str] = "" ) -> List[str]: """Return a sorted list of settings_classes or connection properties To support sorting the required properites of settings_classes first, the settingsname can be passed ad prefix argument to let the key function return the correct sort index for the given settingsname property. """ keys = {f'{prefix}{k}' for d in dicts for k in d.keys()} return sorted(keys, key=key) def node_to_dict(node: Any, tag: str, key_attr: str) -> Dict[str, Any]: dictionary = collections.OrderedDict() if node is not None: for n in node.iter(tag): k = n.get(key_attr) assert k is not None dictionary[k] = n return dictionary def node_get_attr(nodes: List[Optional[Any]], name: str) -> Any: for n in nodes: if n is None: continue x = n.get(name, None) if x: return x return None def node_set_attr(dst_node: Any, name: str, nodes: List[Optional[Any]]) -> None: x = node_get_attr(nodes, name) if x: dst_node.set(name, x) def find_first_not_none(itr: List[Any]) -> Optional[Any]: return next((i for i in itr if i is not None), None) # Generate docs/options.rst, see: # https://github.com/python-sdbus/python-sdbus-networkmanager/pull/39#issuecomment-1186522147 def open_profile_settings_rst() -> io.TextIOWrapper: profile_settings_rst = open("docs/profile_settings.rst", "w") profile_settings_rst.write("Connection Profile Settings Helpers\n") profile_settings_rst.write("===================================\n\n") return profile_settings_rst def append_sphinx_autoclass(profile_settings: io.TextIOWrapper, classname: str) -> None: classpath = f"sdbus_async.networkmanager.settings.{classname}" profile_settings.write(f"\n.. autoclass:: {classpath}\n :members:\n") # The code quality of this function is poor(Sourcery says 5%), needs refactoring, # also see the rework in tools/generate-settings-dataclasses-jinja.py def main(settings_xml_path: Path) -> None: profile_settings_rst = open_profile_settings_rst() gl_input_files = [settings_xml_path] xml_roots = [ElementTree.parse(f).getroot() for f in gl_input_files] assert all(root.tag == "nm-setting-docs" for root in xml_roots) settings_roots = [node_to_dict(root, "setting", "name") for root in xml_roots] # Generate the file header license = "SPDX-License-Identifier: LGPL-2.1-or-later" script = "This file was generated by tools/generate-settings-dataclasses.py" header = f"""# {license}\n# {script}, # if possible, please make changes by also updating the script.\n""" i = open("sdbus_async/networkmanager/settings/__init__.py", mode="w") profile_path = "sdbus_async/networkmanager/settings/profile.py" profile_py = open(profile_path).read() # define start and end markers for generating part of settings/profile.py: start_string = "# start of the generated list of settings classes\n" start_index = profile_py.index(start_string) + len(start_string) end_string = " # end of the generated list of settings classes\n" end_index = profile_py.index(end_string) profile_path_new = f"{profile_path}.new" p = open(profile_path_new, mode="w") # write the file headers i.write(header) p.write(profile_py[:start_index]) classes = [] # generate the connection type settings classes: for settingname in iter_keys_of_dicts(settings_roots, key_fcn_setting_name): settings = [d.get(settingname) for d in settings_roots] properties = [node_to_dict(s, "property", "name") for s in settings] if properties == [OrderedDict()]: continue if settingname in ["tc", "sriov"]: continue # Not supported by this codegen yet(needs Qdiscs and vfs) module = settingname.replace('-', '_') for prefix in ["6", "802_11_", "802_3_"]: if module.startswith(prefix): module = module.replace(prefix, "") break if settingname.startswith("802-1x"): module = f"ieee{module}" temp = module.split('_') + ["Settings"] classname = temp[0].title() + ''.join(ele.title() for ele in temp[1:]) if classname.startswith("Ieee"): classname.replace("Ieee", "IEEE") i.write(f"from .{module} import {classname}\n") classes.append(classname) f = open(f"sdbus_async/networkmanager/settings/{module}.py", mode="w") # Generate module type headers with the needed import statements f.write(header) f.write("from __future__ import annotations\n") f.write("from dataclasses import dataclass, field\n") f.write("from typing import") if module in ["bond", "ethernet", "ovs_external_ids", "vpn", "user"]: f.write(" Dict,") if module in list_modules: f.write(" List,") f.write(" Optional\n") f.write("from .base import NetworkManagerSettingsMixin\n") if settingname.startswith("ipv"): f.write("from .datatypes import AddressData, RouteData\n") if settingname.startswith("bridge"): f.write("from .datatypes import Vlans\n") if settingname.startswith("team"): f.write("from .datatypes import LinkWatchers\n") if settingname == "wireguard": f.write("from .datatypes import WireguardPeers as Peers\n") f.write("\n\n") # Generate the settings_class and it's entry in profile.py: if module != "connection": p.write(f" {module}: Optional[{classname}] = field(\n") p.write(f" metadata={{'dbus_name': '{settingname}',\n") p.write(f" 'settings_class': {classname}}},\n") p.write(" default=None,\n") p.write(" )\n") f.write("@dataclass\n") f.write(f"class {classname}(NetworkManagerSettingsMixin):\n") append_sphinx_autoclass(profile_settings_rst, classname) # generate the docstring of the new settings_class desc = node_get_attr(settings, "description") f.write(' """' + desc + '"""\n\n') # Generate the attributes of the settings_class for this profile type: for property in iter_keys_of_dicts( properties, key_fcn_property_name, f'{settingname}.' ): property_name = property[len(settingname) + 1 :] properties_attrs = [p.get(property_name) for p in properties] t = node_get_attr(properties_attrs, "type") attribute = property_name.replace('-', '_') for builtin in ["id", "type"]: if attribute == builtin: attribute = f"{module}_{attribute}" if not t: t = "string" if t.startswith("array of legacy"): continue if t not in dbus_name_type_map: print(f"{settingname}.{property_name}: type '{t}' not found") ty = t.replace(")", "")[-5:] if ty in dbus_name_type_map: t = ty if t in ["{sv}'"]: t = "{sv}" dbustype = dbus_name_type_map[t] if dbustype == "aa{sv}": default = node_get_attr(properties_attrs, "default") inner_cls = ( property_name.title().replace("-", "").replace("data", "Data") ) f.write(f" {attribute}: Optional[List[{inner_cls}]] = field(\n") f.write(f" metadata={{'dbus_name': '{property_name}',\n") f.write(f" 'dbus_type': '{dbustype}',\n") f.write(f" 'dbus_inner_class': {inner_cls}}},\n") f.write(f" default={str(default).title()},\n )\n") else: attribute_type = dbus_type_name_map[dbustype] optional = property not in _property_name_order if optional: f.write(f" {attribute}: Optional[{attribute_type}]") else: f.write(f" {attribute}: {attribute_type}") f.write(" = field(\n") meta = f"'dbus_name': '{property_name}', " f"'dbus_type':@'{dbustype}'" line = "metadata={" + meta + "}," wrapper = textwrap.TextWrapper( width=80, initial_indent=" ", subsequent_indent=" ", ) lines = wrapper.wrap(text=line) for line in lines: f.write(line.replace(":@", ": ") + '\n') default = node_get_attr(properties_attrs, "default") if default in ["{}", "0", "-1"]: default = None if optional: if dbustype == "a{ss}" and default: default = f"field(default_factory = lambda: {default})" else: default = str(default).title() # FALSE -> False f.write(f" default={default},\n") f.write(" )\n") # Generate docstrings for attributes: Not stored by python, # but is parsed for generating documentation and be red by # developers when they lookup the attribute declaration: generate_descriptions_for_attributes = True if generate_descriptions_for_attributes: attr_description = node_get_attr(properties_attrs, "description") # Fix warning from sphinx: WARNING: # Inline substitution_reference start-string without end-string attr_docstring = attr_description.replace("|", "\|") wrapper = textwrap.TextWrapper( width=82, initial_indent=" ", subsequent_indent=" ", ) lines = wrapper.wrap(text=f'"""{attr_docstring}"""') if len(lines) == 1: print(lines[0] + '"""') else: for line in lines: f.write(f'{line}\n') # If the closing """ shall be on a new line, use: # f.write(' """\n') f.write("") i.write('\n__all__ = (\n') for cls in classes: i.write(f" '{cls}',\n") i.write(")\n") p.write(profile_py[end_index:]) os.rename(profile_path_new, profile_path) if __name__ == '__main__': arg_parser = ArgumentParser() arg_parser.add_argument( 'nm_settings_xml', type=Path, default=Path('man/nm-settings-docs-dbus.xml'), ) args = arg_parser.parse_args() main(args.nm_settings_xml) python-sdbus-networkmanager-2.0rc2/tools/jinja_templates/000077500000000000000000000000001442124064700237605ustar00rootroot00000000000000python-sdbus-networkmanager-2.0rc2/tools/jinja_templates/__init__.py.jinja2000066400000000000000000000013741442124064700272520ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from .profile import ConnectionProfile {% for setting in all_settings -%} from .{{ setting.snake_name }} import {{ setting.python_class_name }} {% endfor %} from .datatypes import ( AddressData, RouteData, LinkWatchers, Vlans, WireguardPeers, RoutingRules, Vfs, ) __all__ = ( 'ConnectionProfile', {%- for setting in all_settings %} '{{ setting.python_class_name }}', {%- endfor %} 'AddressData', 'RouteData', 'LinkWatchers', 'Vlans', 'WireguardPeers', 'RoutingRules', 'Vfs', ) python-sdbus-networkmanager-2.0rc2/tools/jinja_templates/profile.py.jinja2000066400000000000000000000171651442124064700271600ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field, fields from typing import Any, Dict, Generator, Optional from .base import NetworkManagerSettingsMixin {% for setting in all_settings -%} from .{{ setting.snake_name }} import {{ setting.python_class_name }} {% endfor -%} from ..types import NetworkManagerConnectionProperties, SettingsDict @dataclass class ConnectionProfile: """ Connection profiles ------------------- NetworkManager is based on a concept of connection profiles, most often referred to just as "connections". Connection profiles provide a network configuration. When NetworkManager activates a connection profile on a network device, the configuration will be applied and an active network connection will be established. Users are free to create as many connection profiles as they see fit. Thus they are flexible in having various network configurations for different networking needs: https://networkmanager.pages.freedesktop.org/NetworkManager/NetworkManager/nm-settings-dbus.html Connection profiles are handled by NetworkManager via a settings service and are exported on D-Bus (/org/freedesktop/NetworkManager/Settings/) Definition of a connection profile: A specific, encapsulated, independent group of settings describing all the configuration required to connect to a specific network. It is referred to by a unique identifier called the UUID. A connection profile is tied to a one specific device type, but not necessarily a specific hardware device. A connection profile is composed of one or more Settings objects. Settings objects ---------------- A group of related key/value pairs describing a specific piece of a Connection (profile). Keys are also referred to as properties. """ # The list of the settings classes was generated by # tools/generate-settings-dataclasses-jinja.py which generates the # settings classes themselfes as well. # If possible, please make changes by also updating the script. # start of the generated list of settings classes {%- for setting in all_settings %} {{ setting.snake_name }}: {%- if setting.is_optional_setting %} Optional[{{ setting.python_class_name }}] {% else %} {{ setting.python_class_name }} {% endif -%} = field( metadata={'dbus_name': '{{ setting.name }}', 'settings_class': {{ setting.python_class_name }}}, {%- if setting.is_optional_setting %} default=None, {%- else %} default_factory={{ setting.python_class_name }}, {%- endif %} ) {%- endfor %} # end of the generated list of settings classes def to_dbus(self) -> NetworkManagerConnectionProperties: new_dict: NetworkManagerConnectionProperties = {} for x in fields(self): value = getattr(self, x.name) if value is None: continue new_dict[x.metadata['dbus_name']] = value.to_dbus() return new_dict def to_settings_dict(self, defaults: bool = False) -> SettingsDict: """Return a simple dictionary using the same key names like the dbus dict from to_dbus(), but without the dbus signatures returned by it. Contrary to dataclasses.asdict(), it provides the orignal dbus keys, e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type". The key names provided are exactly as documented in these tables: https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html param defaults: Whether properies with default values are returned. """ new_dict = {} for x in fields(self): settings_class = getattr(self, x.name) if settings_class: settingsdomain_dict = settings_class.to_settings_dict(defaults) if settingsdomain_dict != {}: new_dict[x.metadata['dbus_name']] = settingsdomain_dict return new_dict @property def dbus_name_to_settings_class(self) -> Dict[str, str]: return {f.metadata['dbus_name']: f.name for f in fields(self)} @classmethod def from_dbus(cls, dbus_dict: NetworkManagerConnectionProperties ) -> ConnectionProfile: for domain in ("ipv4", "ipv6"): group = dbus_dict.get(domain, None) if group: for key in ("addresses", "routes"): group.pop(key, None) try: unvarianted_options: Dict[str, Any] = { SETTING_DBUS_NAME_TO_NAME[k]: SETTING_TO_CLASS[k].from_dbus(v) for k, v in dbus_dict.items()} except KeyError as e: print(dbus_dict) raise e return cls(**unvarianted_options) @classmethod def from_settings_dict( cls, settings_dict: SettingsDict ) -> ConnectionProfile: """Return a ConnectionProfile created from a simple settings dict A simple settings dict uses the same keys as from_dbus() and to_dbus() but without the dbus variable signatures used by NetworkManader.py This means a simple settings dict does not use the underscore in keys like the attributes of this class have to use and use "id" and "type". """ unvarianted_options: Dict[str, Any] = { SETTING_DBUS_NAME_TO_NAME[k]: SETTING_TO_CLASS[k].from_dict(v) for k, v in settings_dict.items()} return cls(**unvarianted_options) def update(self, other: ConnectionProfile) -> None: """Update this connection profile with the settings from the other. Similar to dict.update method. """ for f in fields(other): settings_field_name = f.name other_settings = getattr(other, settings_field_name) if other_settings is None: continue my_settings = getattr(self, settings_field_name) if my_settings is None: setattr(self, settings_field_name, other_settings) continue for setting_field in fields(other_settings): setting_field_name = setting_field.name other_setting = getattr(other_settings, setting_field_name) if other_setting is None: continue setattr(my_settings, setting_field_name, other_setting) def update_secrets_generator( self) -> Generator[str, ConnectionProfile, None]: for attr_name, value in vars(self).items(): if value is None: continue if not isinstance(value, NetworkManagerSettingsMixin): continue secret_setting_name = value.secret_name if not secret_setting_name: continue secret_profile = yield secret_setting_name current_setting_secrets = getattr(secret_profile, attr_name) for secret_attribute in value.secret_fields_names: setattr( value, secret_attribute, getattr( current_setting_secrets, secret_attribute, ), ) SETTING_DBUS_NAME_TO_NAME: Dict[str, str] = { f.metadata['dbus_name']: f.name for f in fields(ConnectionProfile) } SETTING_TO_CLASS: Dict[str, NetworkManagerSettingsMixin] = { f.metadata['dbus_name']: f.metadata['settings_class'] for f in fields(ConnectionProfile) } python-sdbus-networkmanager-2.0rc2/tools/jinja_templates/profile_settings.rst.jinja2000066400000000000000000000003331442124064700312450ustar00rootroot00000000000000Connection Profile Settings Helpers =================================== {% for setting in all_settings -%} .. autoclass:: sdbus_async.networkmanager.settings.{{ setting.python_class_name }} :members: {% endfor %} python-sdbus-networkmanager-2.0rc2/tools/jinja_templates/setting.py.jinja2000066400000000000000000000022711442124064700271650ustar00rootroot00000000000000# SPDX-License-Identifier: LGPL-2.1-or-later # This file was generated by tools/generate-settings-dataclasses-jinja.py, # if possible, please make changes by also updating the script. from __future__ import annotations from dataclasses import dataclass, field from typing import {{ setting.typing_imports|sort|join(', ') }} from .base import NetworkManagerSettingsMixin {% if setting.datatypes_imports -%} from .datatypes import {{ setting.datatypes_imports|sort|join(', ') }} {% endif %} @dataclass class {{ setting.python_class_name }}(NetworkManagerSettingsMixin): """{{ setting.description }}""" {%- if setting.secret_fields %} secret_fields_names = ['{{ setting.secret_fields|sort|join("', '") }}'] secret_name = '{{ setting.name }}' {%- endif %} {% for property in setting.properties %} {{ property.python_name }}: Optional[{{ property.python_type }}] = field( metadata={ 'dbus_name': '{{ property.name }}', 'dbus_type': '{{ property.dbus_type }}', {%- if property.python_inner_class %} 'dbus_inner_class': {{ property.python_inner_class }}, {%- endif %} }, default=None, ) """{{property.description}}"""{% endfor %}