RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 960071 - [nmcli] enhance nmcli man page DESCRIPTION section
Summary: [nmcli] enhance nmcli man page DESCRIPTION section
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: NetworkManager
Version: 7.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Thomas Haller
QA Contact: Desktop QE
URL:
Whiteboard: nmcli-demo-0413
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-05-06 14:26 UTC by Jirka Klimes
Modified: 2014-06-18 02:45 UTC (History)
4 users (show)

Fixed In Version: NetworkManager-0.9.9.0-10.git20130906
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-06-13 11:58:43 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jirka Klimes 2013-05-06 14:26:58 UTC
The test in DESCRIPTION section of nmcli man page is out-dated and should be rewritten so that it reflects current nmcli state.

(I thought we have a bug for that, but I can't found it now. If it really exists, feel free to make this one duplicate of the older one).

Comment 3 Dan Williams 2013-08-13 14:37:21 UTC
Some problems with the manpage:

1) it only talks about controlling and reporting on NM's status, but nmcli also includes editing and new connection features too.  Basically, 'nmcli is a full featured command-line client for controlling and configuring networking with NetworkManager' or some variation on that theme.

2) it is actually meant as a full replacement for nm-applet these days, since we'll be adding a secret agent to it here at some point to handle secrets from the commandline without a GUI.  A couple places talk about how the cli can't do secrets, and we should change that.

3) Should say "typical uses include" instead of "applications"

4) The use-cases should be re-arranged to be server/headless/terminal window and scripts (not initscripts), and just drop the user sessions part.  We want to ensure that users know that they can edit and create connections here too, not just control them.  For scripts, we want to ensure that users know that nmcli has special output formatting options to maek life easier for scripts, and it should refer to 'man NetworkManager' for more information about the dispatcher script functionality too.

Comment 4 Thomas Haller 2013-08-15 12:32:36 UTC
Please have a look at the first version:

http://cgit.freedesktop.org/NetworkManager/NetworkManager/commit/?id=0926c0c0bb13eb4aab165cff32afd5ca9b9a271f , branch "thaller/cli-enhance-manpage"

Comment 5 Dan Williams 2013-08-16 18:08:15 UTC
Some slight rewording:

is a command\(hyline tool for controlling NetworkManager and reporting network status. It can be utilized as a replacement for \fInm\(hyapplet\fP or other graphical clients. \fInmcli\fP is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network device status.

---

Scripts: utilize NetworkManager via \fInmcli\fP instead of managing network connections manually.  \fInmcli\fP supports a terse output format which is better suited for script processing. Note that Networkmanager can also execute scripts, called "dispatcher scripts", in response to network events. See \fBNetworkManager\fP for details about these dispatcher scripts.

---

Servers, headless machines, and terminals:  \fInmcli\fP can be used to control NetworkManager without a GUI, including creating, editing, starting and stopping network connections and viewing network status.


THanks!

Comment 6 Thomas Haller 2013-08-20 12:56:22 UTC
I reworded the text according to comment #5 and pushed it to master.

See commit 253b78312951894b0ac4ac677888c91c13d61aa9

Comment 9 Martin Simon 2014-02-13 16:01:40 UTC
Verified in version NetworkManager-0.9.9.0-38.git20140131.el7.x86_64. The man page of nmcli is fixed according to comments above. Moving to VERIFIED

Comment 10 Ludek Smid 2014-06-13 11:58:43 UTC
This request was resolved in Red Hat Enterprise Linux 7.0.

Contact your manager or support representative in case you have further questions about the request.


Note You need to log in before you can comment on or make changes to this bug.