Merge "Add description for vendor passthru methods"

1 files changed, 8 insertions, 2 deletions

diff --git a/ironic/drivers/modules/ipmitool.py b/ironic/drivers/modules/ipmitool.py
index c06cee2d5..283c33eb6 100644
--- a/ironic/drivers/modules/ipmitool.py
+++ b/ironic/drivers/modules/ipmitool.py
@@ -1042,7 +1042,10 @@ class VendorPassthru(base.VendorInterface):
         _constructor_checks(driver=self.__class__.__name__)
 
     @METRICS.timer('VendorPassthru.send_raw')
-    @base.passthru(['POST'])
+    @base.passthru(['POST'],
+                   description=_("Send raw bytes to the BMC. Required "
+                                 "argument: 'raw_bytes' - a string of raw "
+                                 "bytes (e.g. '0x00 0x01')."))
     @task_manager.require_exclusive_lock
     def send_raw(self, task, http_method, raw_bytes):
         """Send raw bytes to the BMC. Bytes should be a string of bytes.
@@ -1058,7 +1061,10 @@ class VendorPassthru(base.VendorInterface):
         send_raw(task, raw_bytes)
 
     @METRICS.timer('VendorPassthru.bmc_reset')
-    @base.passthru(['POST'])
+    @base.passthru(['POST'],
+                   description=_("Reset the BMC. Required argument: 'warm' "
+                                 "(Boolean) - for warm (True) or cold (False) "
+                                 "reset."))
     @task_manager.require_exclusive_lock
     def bmc_reset(self, task, http_method, warm=True):
         """Reset BMC with IPMI command 'bmc reset (warm|cold)'.