Changes/NetworkManagerCLIAddConnection

From FedoraProject

< Changes(Difference between revisions)
Jump to: navigation, search
(Add tracker bug)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
= Adding NetworkManager Connections via CLI =
+
= Adding and Editing NetworkManager Connections via CLI =
  
 
== Summary ==
 
== Summary ==
Support for adding new NetworkManager connections using the nmcli commandline tool.
+
Support for adding and editing new NetworkManager connections using the nmcli commandline tool.
  
 
== Owner ==
 
== Owner ==
Line 16: Line 16:
 
== Current status ==
 
== Current status ==
 
* Targeted release: [[Releases/20|Fedora 20]]
 
* Targeted release: [[Releases/20|Fedora 20]]
* Last updated: 2013-07-17
+
* Last updated: 2013-10-14
 
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
 
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
 
Bugzilla states meaning as usual:
 
Bugzilla states meaning as usual:
Line 26: Line 26:
 
-->
 
-->
 
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=998530 #998530]
 
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=998530 #998530]
 +
* Percentage of completion: 100%
  
 
== Detailed Description ==
 
== Detailed Description ==
Administrators will be able to configure new connections via a simple command-line interface. It will be possible to create and activate new connections, as well as delete them.
+
NetworkManagers command line interface nmcli will get new functionality and be able to add, edit, delete, activate and deactivate connections.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
Users more comfortable with the command-line will now have a capable network configuration tool in addition to directly editing network configuration files. Adding and changing network connections is a common task and should be easy to do from the command-line, in addition to GUI tools like nm-connection-editor. These enhancements will add support for configuring all major network connection types supported by NetworkManager (including bridge, bond, vlan, wifi, ethernet, 3G/4G, etc) from an interactive mode of nmcli.
+
Users more comfortable with the command-line will now have a capable network configuration tool in addition to directly editing network configuration files. Adding and changing network connections is a common task and should be easy to do from the command-line, in addition to GUI tools like nm-connection-editor. These enhancements will add support for configuring all major network connection types supported by NetworkManager (including bridge, bond, vlan, wifi, ethernet, 3G/4G, etc.) from an interactive mode of nmcli. nmcli can be used as a full replacement for existing UI tools. nmcli can also create easily parsable output intended for scripting so that shell scripts have an easier access to the dbus interface.
  
 
== Scope ==
 
== Scope ==
Line 39: Line 40:
 
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 
* Release engineering: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Release engineering: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuid required?  If a rel-eng ticket exists, add a link here.  -->
+
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  If a rel-eng ticket exists, add a link here.  -->
 
* Policies and guidelines: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Policies and guidelines: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->
 
<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->
Line 47: Line 48:
  
 
== How To Test ==
 
== How To Test ==
Create a connection using nmcli and check that it was successful.
+
Create a connection using nmcli and check that it was successful. Use the edit mode of nmcli to modify existing connections. It is especially interesting to test various and less common connection types beside ethernet and wifi.
  
 
== User Experience ==
 
== User Experience ==
Line 57: Line 58:
 
== Contingency Plan ==
 
== Contingency Plan ==
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: Administrators can continue hand-editing configuration files in keyfile or ifcfg format.
+
* Contingency mechanism: Administrators can continue hand-editing configuration files in keyfile or ifcfg format. For desktop users there are other UI configuration tools such as nm-connection-editor.
 
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
 
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
 
* Contingency deadline: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Contingency deadline: N/A  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->

Latest revision as of 16:14, 14 October 2013

Contents

[edit] Adding and Editing NetworkManager Connections via CLI

[edit] Summary

Support for adding and editing new NetworkManager connections using the nmcli commandline tool.

[edit] Owner

[edit] Current status

  • Targeted release: Fedora 20
  • Last updated: 2013-10-14
  • Tracker bug: #998530
  • Percentage of completion: 100%

[edit] Detailed Description

NetworkManagers command line interface nmcli will get new functionality and be able to add, edit, delete, activate and deactivate connections.

[edit] Benefit to Fedora

Users more comfortable with the command-line will now have a capable network configuration tool in addition to directly editing network configuration files. Adding and changing network connections is a common task and should be easy to do from the command-line, in addition to GUI tools like nm-connection-editor. These enhancements will add support for configuring all major network connection types supported by NetworkManager (including bridge, bond, vlan, wifi, ethernet, 3G/4G, etc.) from an interactive mode of nmcli. nmcli can be used as a full replacement for existing UI tools. nmcli can also create easily parsable output intended for scripting so that shell scripts have an easier access to the dbus interface.

[edit] Scope

[edit] Upgrade/compatibility impact

Some of the arguments to nmcli will change, which may impact scripts. Reasonable efforts to interpret the old option formats will be made.

[edit] How To Test

Create a connection using nmcli and check that it was successful. Use the edit mode of nmcli to modify existing connections. It is especially interesting to test various and less common connection types beside ethernet and wifi.

[edit] User Experience

Users comfortable with the command-line can run nmcli in an interactive mode to create or edit network connections through an interface similar to mysql or fdisk.

[edit] Dependencies

None.

[edit] Contingency Plan

  • Contingency mechanism: Administrators can continue hand-editing configuration files in keyfile or ifcfg format. For desktop users there are other UI configuration tools such as nm-connection-editor.
  • Contingency deadline: N/A
  • Blocks release? N/A

[edit] Documentation

Documentation will be drafted at Networking/CLI.

[edit] Release Notes

NetworkManager's nmcli command-line tool now supports adding and editing network connections.