reboot required/commit required are conflated

[Christopher Dearborn]

In WSMAN, certain setter/creater methods return two values. One indicates if the server needs to be rebooted to have the changes applied (RebootRequired), and the other indicates if a configuration job needs to be created to have the changes applied (SetResults).

Currently in python-dracclient, only commit_required is returned and the value of it indicates if a reboot is required. The value of this parameter should indicate if a configuration job needs to be created, not if a reboot is required, and an additional parameter should be returned that indicates if reboot is required.

The reason that this works at the present time is because apparently both a reboot and a configuration job are required when setting BIOS settings. This is not the case though with iDRACCardSettings.

In addition, the possible values of reboot required are currently only True and False. While this is true for BIOS settings, it is not true when performing RAID operations. RAID operations can return "YES", "NO", and "OPTIONAL" from the iDRAC.

We need to modify python-dracclient to return indicators of when a configuration job needs to be created as well as when a server needs to be rebooted. These indicators should be separate and distinct. The value of the reboot required indicator should allow 3 possible return values, not just 2.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/520225

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/520225
Committed: https://git.openstack.org/cgit/openstack/python-dracclient/commit/?id=72ea2323e5969adc445d622e34b3b7455ea6c1c9
Submitter: Zuul
Branch: master

commit 72ea2323e5969adc445d622e34b3b7455ea6c1c9
Author: Christopher Dearborn <email address hidden>
Date: Wed Nov 15 17:11:26 2017 -0500

    Separate reboot required from commit required

    This patch separates indicators for reboot required and commit required.
    It does this by adding two new keys (is_reboot_required and
    is_commit_required) to the dictionary returned by set/create/modify
    operations while continuing to return the commit_required key for
    backwards compatibility.

    The commit_required key should be considered deprecated at this time and
    it will be removed in a future patch.

    The is_reboot_required key has an enumerated value that can have three
    possible values: true, optional, and false. This allows the return of
    optional for RAID operations that can return this value.

    Change-Id: I70e52868f10bfafb30bbb38b85888bc4ec8e65ae
    Closes-Bug: 1732549