summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorAnne Gentle <agentle@cisco.com>2016-10-24 10:55:10 +0200
committerSteve Martinelli <s.martinelli@gmail.com>2016-10-25 08:51:20 +0200
commit5055074db00f75285034c056b631d85f42cd9086 (patch)
treec4f4eee09274ed082ada3184e9f7c620f85ee734 /doc/source/command-objects
parentbe9306f1d4ad8aedbbe2470163ff3dd9566e7a00 (diff)
downloadpython-openstackclient-5055074db00f75285034c056b631d85f42cd9086.tar.gz
Adds information about private key generation for instance access
- Also updated the help text in the command itself. Change-Id: Ib3d4f94ef415a3f12024d0d7c000d2de20de001b Partial-Bug: 1549410
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/keypair.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
index af50a651..c9bf085b 100644
--- a/doc/source/command-objects/keypair.rst
+++ b/doc/source/command-objects/keypair.rst
@@ -3,14 +3,16 @@ keypair
=======
The badly named keypair is really the public key of an OpenSSH key pair to be
-used for access to created servers.
+used for access to created servers. You can also create a private key for
+access to a created server by not passing any argument to the keypair create
+command.
Compute v2
keypair create
--------------
-Create new public key
+Create new public or private key for server ssh access
.. program:: keypair create
.. code:: bash
@@ -21,16 +23,16 @@ Create new public key
.. option:: --public-key <file>
- Filename for public key to add
+ Filename for public key to add. If not used, creates a private key.
.. describe:: <name>
- New public key name
+ New public or private key name
keypair delete
--------------
-Delete public key(s)
+Delete public or private key(s)
.. program:: keypair delete
.. code:: bash
@@ -40,12 +42,12 @@ Delete public key(s)
.. describe:: <key>
- Public key(s) to delete (name only)
+ Name of key(s) to delete (name only)
keypair list
------------
-List public key fingerprints
+List key fingerprints
.. program:: keypair list
.. code:: bash
@@ -55,7 +57,7 @@ List public key fingerprints
keypair show
------------
-Display public key details
+Display key details
.. program:: keypair show
.. code:: bash
@@ -66,8 +68,8 @@ Display public key details
.. option:: --public-key
- Show only bare public key (name only)
+ Show only bare public key paired with the generated key
.. describe:: <key>
- Public key to display (name only)
+ Public or private key to display (name only)