Bug 1227527 - [Docs] [Technical] Information on power management options must be added to the REST API documentation
Summary: [Docs] [Technical] Information on power management options must be added to t...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.5.1
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ovirt-3.5.6
: 3.5.5
Assignee: Andrew Burden
QA Contact: Tahlia Richardson
URL:
Whiteboard: docs
Depends On:
Blocks: 1277358
TreeView+ depends on / blocked
 
Reported: 2015-06-02 22:30 UTC by Andrew Dahms
Modified: 2019-07-16 11:57 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-11-20 04:10:02 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Andrew Dahms 2015-06-02 22:30:57 UTC
The following options for power management must be documented in the content on REST API -

  <automatic_pm_enabled>true</automatic_pm_enabled
  <kdump_detection>true</kdump_detection>

These options are available for hosts.

Comment 1 Andrew Dahms 2015-06-02 22:31:48 UTC
Assigning to Andrew for review.

Comment 4 Philipp Gassmann 2015-06-03 13:26:42 UTC
The documentation lacks the information on the default value and is even misleading by stating "setting this to true will ..." which implies that the default is false.

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Technical_Guide/index.html#Power_Management_Elements
automatic_pm_enabled	
Boolean: true or false 	
Toggles the automated power control of the host in order to save energy. Setting this to true will enable the host to be automatically powered down if the cluster's load is low. The host will be automatically powered on again when required.	 

kdump_detection
	Boolean: true or false	
Toggles whether to determine if kdump is running on the host before it is shut down. Setting this to true will prevent the host from being shut down so as to not interrupt the kdump process.

Comment 5 Andrew Burden 2015-06-15 09:00:46 UTC
Hello Philipp,

Thanks for the feedback. I see your point about how it can be construed. I'm moving this back to MODIFIED and will update the docs for next publication. 

One thing to note: the API behaviour is entirely dependent on the backend processing. As such, it is recommended that explicit values be provided for relevant options.

Cheers

Comment 8 Andrew Burden 2015-11-20 04:10:02 UTC
3.6 Beta documentation can be found at https://access.redhat.com/documentation/en/red-hat-enterprise-virtualization/


Note You need to log in before you can comment on or make changes to this bug.