summaryrefslogtreecommitdiff
path: root/doc/source/cli
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli')
-rw-r--r--doc/source/cli/command-objects/complete.rst7
-rw-r--r--doc/source/cli/command-objects/volume-backend.rst8
-rw-r--r--doc/source/cli/commands.rst2
-rw-r--r--doc/source/cli/data/cinder.csv4
-rw-r--r--doc/source/cli/data/keystone.csv2
-rw-r--r--doc/source/cli/data/neutron.csv10
6 files changed, 23 insertions, 10 deletions
diff --git a/doc/source/cli/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst
index 20e5c41d..165d5d07 100644
--- a/doc/source/cli/command-objects/complete.rst
+++ b/doc/source/cli/command-objects/complete.rst
@@ -11,8 +11,11 @@ Typical usage for this command is::
openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null
-If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``),
-then this command will likely be run for you.
+It is highly recommended to install ``python-openstackclient`` from a package
+(``apt-get`` or ``yum``). In some distributions the package ``bash-completion`` is shipped
+as dependency, and the `openstack complete` command will be run as a post-install action,
+however not every distribution include this dependency and you might need to install
+``bash-completion`` package to enable autocomplete feature.
complete
--------
diff --git a/doc/source/cli/command-objects/volume-backend.rst b/doc/source/cli/command-objects/volume-backend.rst
new file mode 100644
index 00000000..0285d61b
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-backend.rst
@@ -0,0 +1,8 @@
+==============
+volume backend
+==============
+
+Volume v2
+
+.. autoprogram-cliff:: openstack.volume.v2
+ :command: volume backend *
diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst
index 76126a74..d7c91240 100644
--- a/doc/source/cli/commands.rst
+++ b/doc/source/cli/commands.rst
@@ -156,6 +156,8 @@ referring to both Compute and Volume quotas.
* ``user role``: (**Identity**) roles assigned to a user
* ``volume``: (**Volume**) block volumes
* ``volume backup``: (**Volume**) backup for volumes
+* ``volume backend capability``: (**volume**) volume backend storage capabilities
+* ``volume backend pool``: (**volume**) volume backend storage pools
* ``volume host``: (**Volume**) the physical computer for volumes
* ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes
* ``volume snapshot``: (**Volume**) a point-in-time copy of a volume
diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv
index 5c89e086..cc8ef2d9 100644
--- a/doc/source/cli/data/cinder.csv
+++ b/doc/source/cli/data/cinder.csv
@@ -32,8 +32,8 @@ extra-specs-list,volume type list --long,Lists current volume types and extra sp
failover-host,volume host failover,Failover a replicating cinder-volume host.
force-delete,volume delete --force,"Attempts force-delete of volume, regardless of state."
freeze-host,volume host set --disable,Freeze and disable the specified cinder-volume host.
-get-capabilities,,Show backend volume stats and properties. Admin only.
-get-pools,,Show pool information for backends. Admin only.
+get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only.
+get-pools,volume backend pool list,Show pool information for backends. Admin only.
image-metadata,volume set --image-property,Sets or deletes volume image metadata.
image-metadata-show,volume show,Shows volume image metadata.
list,volume list,Lists all volumes.
diff --git a/doc/source/cli/data/keystone.csv b/doc/source/cli/data/keystone.csv
index 03c34704..bcc30551 100644
--- a/doc/source/cli/data/keystone.csv
+++ b/doc/source/cli/data/keystone.csv
@@ -18,7 +18,7 @@ service-get,service show,Display service from Service Catalog.
service-list,service list,List all services in Service Catalog.
tenant-create,project create,Create new tenant.
tenant-delete,project delete,Delete tenant.
-tenant-get,proejct show,Display tenant details.
+tenant-get,project show,Display tenant details.
tenant-list,project list,List all tenants.
tenant-update,project set,"Update tenant name, description, enabled status."
token-get,token issue,Display the current user token.
diff --git a/doc/source/cli/data/neutron.csv b/doc/source/cli/data/neutron.csv
index be3f32a8..080114e2 100644
--- a/doc/source/cli/data/neutron.csv
+++ b/doc/source/cli/data/neutron.csv
@@ -50,7 +50,7 @@ flavor-update,network flavor set,Update a Neutron service flavor.
floatingip-associate,floating ip set port --fixed-ip,Create a mapping between a floating IP and a fixed IP.
floatingip-create,floating ip create,Create a floating IP for a given tenant.
floatingip-delete,floating ip delete,Delete a given floating IP.
-floatingip-disassociate,floating ip unset port,Remove a mapping from a floating IP to a fixed IP.
+floatingip-disassociate,floating ip unset --port,Remove a mapping from a floating IP to a fixed IP.
floatingip-list,floating ip list,List floating IPs that belong to a given tenant.
floatingip-show,floating ip show,Show information of a given floating IP.
help,help,print detailed help for another command
@@ -142,12 +142,12 @@ net-ip-availability-show,ip availability show,Show IP usage of specific network
net-list,network list,List networks that belong to a given tenant.
net-list-on-dhcp-agent,network list --agent,List the networks on a DHCP agent.
net-show,network show,Show information of a given network.
-net-update,network set,Update network's information.
+net-update,network set / network unset,Update network's information.
port-create,port create,Create a port for a given tenant.
port-delete,port delete,Delete a given port.
port-list,port list,List ports that belong to a given tenant.
port-show,port show,Show information of a given port.
-port-update,port set/port unset,Update port's information.
+port-update,port set / port unset,Update port's information.
purge,,Delete all resources that belong to a given tenant.
qos-available-rule-types,network qos rule type list,List available qos rule types.
qos-bandwidth-limit-rule-create,network qos rule create --type bandwidth-limit,Create a qos bandwidth limit rule.
@@ -183,7 +183,7 @@ rbac-update,network rbac set,Update RBAC policy for given tenant.
router-create,router create,Create a router for a given tenant.
router-delete,router delete,Delete a given router.
router-gateway-clear,router unset,Remove an external network gateway from a router.
-router-gateway-set,router set,Set the external network gateway for a router.
+router-gateway-set,router set / router unset,Set the external network gateway for a router.
router-interface-add,router add subnet / router add port,Add an internal network interface to a router.
router-interface-delete,router remove subnet / router remove port,Remove an internal network interface from a router.
router-list,router list,List routers that belong to a given tenant.
@@ -199,7 +199,7 @@ security-group-rule-delete,security group rule delete,Delete a given security gr
security-group-rule-list,security group rule list,List security group rules that belong to a given tenant.
security-group-rule-show,security group rule show,Show information of a given security group rule.
security-group-show,security group show,Show information of a given security group.
-security-group-update,security group set,Update a given security group.
+security-group-update,security group set / security group unset,Update a given security group.
service-provider-list,network service provider list,List service providers.
subnet-create,subnet create,Create a subnet for a given tenant.
subnet-delete,subnet delete,Delete a given subnet.