Red Hat Bugzilla – Bug 1227527
[Docs] [Technical] Information on power management options must be added to the REST API documentation
Last modified: 2016-02-10 13:57:33 EST
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.
Assigning to Andrew for review.
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.
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
3.6 Beta documentation can be found at https://access.redhat.com/documentation/en/red-hat-enterprise-virtualization/