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/backup.rst11
-rw-r--r--doc/source/command-objects/compute-agent.rst4
-rw-r--r--doc/source/command-objects/compute-service.rst10
-rw-r--r--doc/source/command-objects/host.rst4
-rw-r--r--doc/source/command-objects/keypair.rst6
-rw-r--r--doc/source/command-objects/network.rst4
-rw-r--r--doc/source/command-objects/router.rst24
-rw-r--r--doc/source/command-objects/subnet.rst7
-rw-r--r--doc/source/command-objects/volume-qos.rst5
9 files changed, 55 insertions, 20 deletions
diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst
index 9d7fb95d..8e657b32 100644
--- a/doc/source/command-objects/backup.rst
+++ b/doc/source/command-objects/backup.rst
@@ -16,6 +16,7 @@ Create new backup
[--container <container>]
[--name <name>]
[--description <description>]
+ [--force]
<volume>
.. option:: --container <container>
@@ -30,6 +31,10 @@ Create new backup
Description of the backup
+.. option:: --force
+
+ Allow to back up an in-use volume
+
.. _backup_create-backup:
.. describe:: <volume>
@@ -49,7 +54,7 @@ Delete backup(s)
.. _backup_delete-backup:
.. describe:: <backup>
- Backup(s) to delete (ID only)
+ Backup(s) to delete (name or ID)
backup list
-----------
@@ -81,7 +86,7 @@ Restore backup
.. _backup_restore-backup:
.. describe:: <backup>
- Backup to restore (ID only)
+ Backup to restore (name or ID)
.. describe:: <volume>
@@ -101,4 +106,4 @@ Display backup details
.. _backup_show-backup:
.. describe:: <backup>
- Backup to display (ID only)
+ Backup to display (name or ID)
diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst
index b00a981d..ae057dc9 100644
--- a/doc/source/command-objects/compute-agent.rst
+++ b/doc/source/command-objects/compute-agent.rst
@@ -59,7 +59,7 @@ Delete compute agent(s)
compute agent list
------------------
-List compute agent command
+List compute agents
.. program:: compute agent list
.. code:: bash
@@ -74,7 +74,7 @@ List compute agent command
compute agent set
-----------------
-Set compute agent command
+Set compute agent properties
.. program:: agent set
.. code:: bash
diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst
index f43b5fa6..57dd2ba5 100644
--- a/doc/source/command-objects/compute-service.rst
+++ b/doc/source/command-objects/compute-service.rst
@@ -7,23 +7,23 @@ Compute v2
compute service delete
----------------------
-Delete service command
+Delete compute service(s)
.. program:: compute service delete
.. code:: bash
os compute service delete
- <service>
+ <service> [<service> ...]
.. _compute-service-delete:
.. describe:: <service>
- Compute service to delete (ID only)
+ Compute service(s) to delete (ID only)
compute service list
--------------------
-List service command
+List compute services
.. program:: compute service list
.. code:: bash
@@ -50,7 +50,7 @@ List service command
compute service set
-------------------
-Set service command
+Set compute service properties
.. program:: compute service set
.. code:: bash
diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst
index 8c34d3fb..409b834b 100644
--- a/doc/source/command-objects/host.rst
+++ b/doc/source/command-objects/host.rst
@@ -9,7 +9,7 @@ The physical computer running a hypervisor.
host list
---------
-List all hosts
+List hosts
.. program:: host list
.. code:: bash
@@ -24,7 +24,7 @@ List all hosts
host set
--------
-Set host command
+Set host properties
.. program:: host set
.. code:: bash
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
index 6638b8c9..64cc20cd 100644
--- a/doc/source/command-objects/keypair.rst
+++ b/doc/source/command-objects/keypair.rst
@@ -30,17 +30,17 @@ Create new public key
keypair delete
--------------
-Delete public key
+Delete public key(s)
.. program:: keypair delete
.. code:: bash
os keypair delete
- <key>
+ <key> [<key> ...]
.. describe:: <key>
- Public key to delete (name only)
+ Public key(s) to delete (name only)
keypair list
------------
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
index 1cf442f2..0c472e7f 100644
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@@ -108,7 +108,7 @@ Create new network
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
- The supported options are: flat, geneve, gre, local, vlan, vxlan
+ The supported options are: flat, geneve, gre, local, vlan, vxlan.
*Network version 2 only*
@@ -238,7 +238,7 @@ Set network properties
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
- The supported options are: flat, gre, local, vlan, vxlan
+ The supported options are: flat, gre, local, vlan, vxlan.
.. option:: --provider-physical-network <provider-physical-network>
diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst
index f6d5500c..bbdca054 100644
--- a/doc/source/command-objects/router.rst
+++ b/doc/source/command-objects/router.rst
@@ -240,3 +240,27 @@ Display router details
.. describe:: <router>
Router to display (name or ID)
+
+router unset
+------------
+
+Unset router properties
+
+.. program:: router unset
+.. code:: bash
+
+ os router unset
+ [--route destination=<subnet>,gateway=<ip-address>]
+ <router>
+
+.. option:: --route destination=<subnet>,gateway=<ip-address>
+
+ Routes to be removed from the router
+ destination: destination subnet (in CIDR notation)
+ gateway: nexthop IP address
+ (repeat option to unset multiple routes)
+
+.. _router_unset-router:
+.. describe:: <router>
+
+ Router to modify (name or ID)
diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst
index 30516789..f0d5e90a 100644
--- a/doc/source/command-objects/subnet.rst
+++ b/doc/source/command-objects/subnet.rst
@@ -83,7 +83,7 @@ Create new subnet
'auto': Gateway address should automatically be chosen from
within the subnet itself, 'none': This subnet will not use
a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway auto``,
- ``--gateway none`` (default is 'auto')
+ ``--gateway none`` (default is 'auto').
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
@@ -158,7 +158,8 @@ List subnets
.. option:: --ip-version {4, 6}
- List only subnets of given IP version in output
+ List only subnets of given IP version in output.
+ Allowed values for IP version are 4 and 6.
subnet set
----------
@@ -200,7 +201,7 @@ Set subnet properties
Specify a gateway for the subnet. The options are:
<ip-address>: Specific IP address to use as the gateway,
'none': This subnet will not use a gateway,
- e.g.: ``--gateway 192.168.9.1``, ``--gateway none``
+ e.g.: ``--gateway 192.168.9.1``, ``--gateway none``.
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst
index 2d9d14a4..f3c7ec21 100644
--- a/doc/source/command-objects/volume-qos.rst
+++ b/doc/source/command-objects/volume-qos.rst
@@ -58,8 +58,13 @@ Delete QoS specification
.. code:: bash
os volume qos delete
+ [--force]
<qos-spec> [<qos-spec> ...]
+.. option:: --force
+
+ Allow to delete in-use QoS specification(s)
+
.. describe:: <qos-spec>
QoS specification(s) to delete (name or ID)