Merge "[Docs] Update client docs to add reason and locked options"

This commit is contained in:
Zuul 2019-05-14 16:04:12 +00:00 committed by Gerrit Code Review
commit b907585d87
2 changed files with 19 additions and 2 deletions

View File

@ -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

View File

@ -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."""