summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSurya Seetharaman <suryaseetharaman.9@gmail.com>2019-05-14 11:31:46 +0200
committerSurya Seetharaman <suryaseetharaman.9@gmail.com>2019-05-14 11:31:46 +0200
commitf0388977c1cc557f4c7cb5bc73964ffdebe35016 (patch)
tree8a2cdd5112be6cf019a81289b0f0cb4716d727aa
parenta1ac69c69a4fede8ac02b165d23f62b30a242a48 (diff)
downloadpython-novaclient-f0388977c1cc557f4c7cb5bc73964ffdebe35016.tar.gz
[Docs] Update client docs to add reason and locked options
This patch adds information about the ``locked`` filter/sorting key and the ``reason`` options that were added in https://review.opendev.org/#/c/648659/. Related to blueprint add-locked-reason Change-Id: I11cc4bd7cee0f03d4398f91bb3790c4c681061f4
-rw-r--r--doc/source/cli/nova.rst17
-rw-r--r--novaclient/v2/shell.py4
2 files changed, 19 insertions, 2 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
diff --git a/novaclient/v2/shell.py b/novaclient/v2/shell.py
index 4e8a730d..88ebf2d7 100644
--- a/novaclient/v2/shell.py
+++ b/novaclient/v2/shell.py
@@ -1568,7 +1568,9 @@ def _print_flavor(flavor):
dest='locked',
metavar='<locked>',
default=None,
- help=_('Display servers based on their locked value'),
+ help=_("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."),
start_version="2.73")
def do_list(cs, args):
"""List servers."""