summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-05-14 16:04:12 +0000
committerGerrit Code Review <review@openstack.org>2019-05-14 16:04:12 +0000
commitb907585d8725c32336b3a86edd22ac63f17239c8 (patch)
tree6b6f4e7edbfce7c21a6e744016138e5727638a6e /doc/source
parenta1d3a181d116ade97c61795848fffabac3484d29 (diff)
parentf0388977c1cc557f4c7cb5bc73964ffdebe35016 (diff)
downloadpython-novaclient-b907585d8725c32336b3a86edd22ac63f17239c8.tar.gz
Merge "[Docs] Update client docs to add reason and locked options"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/cli/nova.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst
index eada5c69..e8078679 100644
--- a/doc/source/cli/nova.rst
+++ b/doc/source/cli/nova.rst
@@ -2223,6 +2223,7 @@ nova list
[--changes-before <changes_before>]
[--tags <tags>] [--tags-any <tags-any>]
[--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
+ [--locked]
List servers.
@@ -2344,6 +2345,14 @@ present in the failure domain.
commas: --not-tags-any <tag1,tag2> (Supported
by API versions '2.26' - '2.latest')
+``--locked <locked>``
+ Display servers based on their locked value. A
+ value must be specified; eg. 'true' will list
+ only locked servers and 'false' will list only
+ unlocked servers. (Supported by API versions
+ '2.73' - '2.latest')
+
+
.. _nova_list-extensions:
nova list-extensions
@@ -2464,7 +2473,7 @@ nova lock
.. code-block:: console
- usage: nova lock <server>
+ usage: nova lock [--reason <reason>] <server>
Lock a server. A normal (non-admin) user will not be able to execute actions
on a locked server.
@@ -2474,6 +2483,12 @@ on a locked server.
``<server>``
Name or ID of server.
+**Optional arguments:**
+
+``--reason <reason>``
+ Reason for locking the server. (Supported by API versions
+ '2.73' - '2.latest')
+
.. _nova_meta:
nova meta