summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/keypair.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/keypair.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/keypair.rst')
-rw-r--r--doc/source/cli/command-objects/keypair.rst80
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst
new file mode 100644
index 00000000..a539f0a2
--- /dev/null
+++ b/doc/source/cli/command-objects/keypair.rst
@@ -0,0 +1,80 @@
+=======
+keypair
+=======
+
+The badly named keypair is really the public key of an OpenSSH key pair to be
+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 or private key for server ssh access
+
+.. program:: keypair create
+.. code:: bash
+
+ openstack keypair create
+ [--public-key <file> | --private-key <file>]
+ <name>
+
+.. option:: --public-key <file>
+
+ Filename for public key to add. If not used, creates a private key.
+
+.. option:: --private-key <file>
+
+ Filename for private key to save. If not used, print private key in
+ console.
+
+.. describe:: <name>
+
+ New public or private key name
+
+keypair delete
+--------------
+
+Delete public or private key(s)
+
+.. program:: keypair delete
+.. code:: bash
+
+ openstack keypair delete
+ <key> [<key> ...]
+
+.. describe:: <key>
+
+ Name of key(s) to delete (name only)
+
+keypair list
+------------
+
+List key fingerprints
+
+.. program:: keypair list
+.. code:: bash
+
+ openstack keypair list
+
+keypair show
+------------
+
+Display key details
+
+.. program:: keypair show
+.. code:: bash
+
+ openstack keypair show
+ [--public-key]
+ <key>
+
+.. option:: --public-key
+
+ Show only bare public key paired with the generated key
+
+.. describe:: <key>
+
+ Public or private key to display (name only)