From 13de3494115c1c460613b9792d1a4186234a25be Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Wed, 16 Jun 2021 18:09:32 +0100
Subject: [PATCH] compute: Better help text for 'openstack server set --state'
Manually changing the server state is a potentially dangerous operation
that should only be done under limited circumstances. It's also an
admin-only operation by default. Highlight both points.
Change-Id: Ifd8aec94937764202131ba8caf6b507caa76d7e9
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Story: 2008549
Task: 41672
---
openstackclient/compute/v2/server.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
index 468c6b1b3e..ef0f714915 100644
--- a/openstackclient/compute/v2/server.py
+++ b/openstackclient/compute/v2/server.py
@@ -4023,7 +4023,12 @@ class SetServer(command.Command):
'--state',
metavar='<state>',
choices=['active', 'error'],
- help=_('New server state (valid value: active, error)'),
+ help=_(
+ 'New server state '
+ '**WARNING** This can result in instances that are no longer '
+ 'usable and should be used with caution '
+ '(admin only)'
+ ),
)
parser.add_argument(
'--description',