summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/hypervisor.rst5
-rw-r--r--doc/source/command-objects/keypair.rst22
-rw-r--r--doc/source/command-objects/router.rst14
-rw-r--r--doc/source/command-objects/security-group-rule.rst7
-rw-r--r--doc/source/command-objects/subnet-pool.rst14
-rw-r--r--doc/source/command-objects/volume-backup.rst36
6 files changed, 81 insertions, 17 deletions
diff --git a/doc/source/command-objects/hypervisor.rst b/doc/source/command-objects/hypervisor.rst
index d6d0469b..3053a758 100644
--- a/doc/source/command-objects/hypervisor.rst
+++ b/doc/source/command-objects/hypervisor.rst
@@ -14,11 +14,16 @@ List hypervisors
os hypervisor list
[--matching <hostname>]
+ [--long]
.. option:: --matching <hostname>
Filter hypervisors using <hostname> substring
+.. option:: --long
+
+ List additional fields in output
+
hypervisor show
---------------
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)
diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst
index 0eaae655..56b95ffa 100644
--- a/doc/source/command-objects/router.rst
+++ b/doc/source/command-objects/router.rst
@@ -134,12 +134,26 @@ List routers
.. code:: bash
os router list
+ [--name <name>]
+ [--enable | --disable]
[--long]
.. option:: --long
List additional fields in output
+.. option:: --name <name>
+
+ List routers according to their name
+
+.. option:: --enable
+
+ List enabled routers
+
+.. option:: --disable
+
+ List disabled routers
+
router remove port
------------------
diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst
index 5284b2dc..69c9fabc 100644
--- a/doc/source/command-objects/security-group-rule.rst
+++ b/doc/source/command-objects/security-group-rule.rst
@@ -22,6 +22,7 @@ Create a new security group rule
[--ingress | --egress]
[--ethertype <ethertype>]
[--project <project> [--project-domain <project-domain>]]
+ [--description <description>]
<group>
.. option:: --src-ip <ip-address>
@@ -97,6 +98,12 @@ Create a new security group rule
*Network version 2 only*
+.. option:: --description <description>
+
+ Set security group rule description
+
+ *Network version 2 only*
+
.. describe:: <group>
Create rule in this security group (name or ID)
diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst
index 28a735d6..bd1356f3 100644
--- a/doc/source/command-objects/subnet-pool.rst
+++ b/doc/source/command-objects/subnet-pool.rst
@@ -121,23 +121,23 @@ List subnet pools
.. option:: --share
- List subnets shared between projects
+ List subnet pools shared between projects
.. option:: --no-share
- List subnets not shared between projects
+ List subnet pools not shared between projects
.. option:: --default
- List subnets used as the default external subnet pool
+ List subnet pools used as the default external subnet pool
.. option:: --no-default
- List subnets not used as the default external subnet pool
+ List subnet pools not used as the default external subnet pool
.. option:: --project <project>
- List subnets according to their project (name or ID)
+ List subnet pools according to their project (name or ID)
.. option:: --project-domain <project-domain>
@@ -146,11 +146,11 @@ List subnet pools
.. option:: --name <name>
- List only subnets of given name in output
+ List only subnet pools of given name in output
.. option:: --address-scope <address-scope>
- List only subnets of given address scope (name or ID) in output
+ List only subnet pools of given address scope (name or ID) in output
subnet pool set
---------------
diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst
index 246fd38e..2cccffae 100644
--- a/doc/source/command-objects/volume-backup.rst
+++ b/doc/source/command-objects/volume-backup.rst
@@ -88,12 +88,48 @@ List volume backups
.. code:: bash
os volume backup list
+ [--long]
+ [--name <name>]
+ [--status <status>]
+ [--volume <volume>]
+ [--marker <marker>]
+ [--limit <limit>]
+ [--all-projects]
.. _volume_backup_list-backup:
.. option:: --long
List additional fields in output
+.. options:: --name <name>
+
+ Filters results by the backup name
+
+.. options:: --status <status>
+
+ Filters results by the backup status
+ ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring')
+
+.. options:: --volume <volume>
+
+ Filters results by the volume which they backup (name or ID)"
+
+.. options:: --marker <marker>
+
+ The last backup of the previous page (name or ID)
+
+ *Volume version 2 only*
+
+.. options:: --limit <limit>
+
+ Maximum number of backups to display
+
+ *Volume version 2 only*
+
+.. option:: --all-projects
+
+ Include all projects (admin only)
+
volume backup restore
---------------------