Adding SetSecureBoot to redfish_config #7129

TSKushal · 2023-08-18T10:07:04Z

SUMMARY
Changing EnableSecureBoot command to SetSecureBoot to facilitate both enabling and disabling of secure boot.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME
redfish_config.py
redfish_utils.py

ansibullbot · 2023-08-18T10:10:47Z

cc @Bhavya06 @jyundt @mraineri @rajeevkallur @renxulei @tomasg2012 @xmadsen
click here for bot help

felixfontein

Thanks for your contribution! Here's a first comment :)

plugins/modules/redfish_config.py

mraineri · 2023-08-18T12:37:02Z

plugins/modules/redfish_config.py

@@ -314,7 +322,7 @@
 # More will be added as module features are expanded
 CATEGORY_COMMANDS_ALL = {
    "Systems": ["SetBiosDefaultSettings", "SetBiosAttributes", "SetBootOrder",
-                "SetDefaultBootOrder", "EnableSecureBoot", "DeleteVolumes"],
+                "SetDefaultBootOrder", "SetSecureBoot", "DeleteVolumes"],


This is a breaking change for users that currently have scripts to invoke "EnableSecureBoot". I like the idea of having a "SetSecureBoot", but we can't remove the existing function without going through proper deprecation notices.

Is there a documentation we can refer to for adding the deprecation notices?

@felixfontein any pointers for this? I haven't had to deprecate anything at yet.

The other option would be to leave EnableSecureBoot alone and just add this new "SetSecureBoot"; there's no harm in leaving the existing command there as far as I can tell.

You can grep for module.deprecate in plugins/, you should find multiple examples there :) Generally I would suggest to first add the new way, wait a few releases (potentially until the next major release), and only then deprecate the old one (with a long deprecation period). That will allow users to gracefully migrate without being bothered by deprecation warnings too quickly.

Noted. Will change this PR to add SetSecureBoot and keep EnableSecureBoot as it is for now, will deprecate it later.

Agreed Co-authored-by: Felix Fontein <[email protected]>

mraineri · 2023-09-20T17:24:19Z

Updates look good to me; thanks!

plugins/modules/redfish_config.py

Agreed Co-authored-by: Felix Fontein <[email protected]>

felixfontein · 2023-09-20T17:48:11Z

Thanks! I'll merge once CI passes.

TSKushal · 2023-09-20T17:50:31Z

Thank you 😄 @mraineri @felixfontein

patchback · 2023-09-20T20:02:46Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/12b48aaa2d946eca5f8dbc8ad47c1bce0971842a/pr-7129

Backported as #7298

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* Changing EnableSecureBoot to SetSecureBoot * Sanity Fix * Adding changelog fragment * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> * Updating PR to just add SetSecureBoot command * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Kushal <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 12b48aa)

felixfontein · 2023-09-20T20:03:10Z

@TSKushal thanks for your contribution!
@mraineri thanks for reviewing!

…h_config (#7298) Adding SetSecureBoot to redfish_config (#7129) * Changing EnableSecureBoot to SetSecureBoot * Sanity Fix * Adding changelog fragment * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> * Updating PR to just add SetSecureBoot command * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Kushal <[email protected]> Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 12b48aa) Co-authored-by: TSKushal <[email protected]>

8.5.0 amazon.aws ~~~~~~~~~~ - ec2_ami - add support for ``org_arns`` and ``org_unit_arns`` in launch_permissions (ansible-collections/amazon.aws#1690). - elb_application_lb_info - drop redundant ``describe_load_balancers`` call fetching ``ip_address_type`` (ansible-collections/amazon.aws#1768). community.general ~~~~~~~~~~~~~~~~~ - cargo - add option ``executable``, which allows user to specify path to the cargo binary (ansible-collections/community.general#7352). - cargo - add option ``locked`` which allows user to specify install the locked version of dependency instead of latest compatible version (ansible-collections/community.general#6134). - dig lookup plugin - add TCP option to enable the use of TCP connection during DNS lookup (ansible-collections/community.general#7343). - gitlab_group - add option ``force_delete`` (default: false) which allows delete group even if projects exists in it (ansible-collections/community.general#7364). - ini_file - add ``ignore_spaces`` option (ansible-collections/community.general#7273). - newrelic_deployment - add option ``app_name_exact_match``, which filters results for the exact app_name provided (ansible-collections/community.general#7355). - onepassword lookup plugin - introduce ``account_id`` option which allows specifying which account to use (ansible-collections/community.general#7308). - onepassword_raw lookup plugin - introduce ``account_id`` option which allows specifying which account to use (ansible-collections/community.general#7308). - parted - on resize, use ``--fix`` option if available (ansible-collections/community.general#7304). - pnpm - set correct version when state is latest or version is not mentioned. Resolves previous idempotency problem (ansible-collections/community.general#7339). - proxmox - add ``vmid`` (and ``taskid`` when possible) to return values (ansible-collections/community.general#7263). - random_string - added new ``ignore_similar_chars`` and ``similar_chars`` option to ignore certain chars (ansible-collections/community.general#7242). - redfish_command - add new option ``update_oem_params`` for the ``MultipartHTTPPushUpdate`` command (ansible-collections/community.general#7331). - redfish_config - add ``CreateVolume`` command to allow creation of volumes on servers (ansible-collections/community.general#6813). - redfish_config - adding ``SetSecureBoot`` command (ansible-collections/community.general#7129). - redfish_info - add support for ``GetBiosRegistries`` command (ansible-collections/community.general#7144). - redfish_info - adds ``LinkStatus`` to NIC inventory (ansible-collections/community.general#7318). - redis_info - refactor the redis_info module to use the redis module_utils enabling to pass TLS parameters to the Redis client (ansible-collections/community.general#7267). - supervisorctl - allow to stop matching running processes before removing them with ``stop_before_removing=true`` (ansible-collections/community.general#7284). community.libvirt ~~~~~~~~~~~~~~~~~ - virt - add `mutate_flags` parameter to enable XML mutation (add UUID, MAC addresses from existing domain) (ansible-collections/community.libvirt#142). - virt - support ``--diff`` for ``define`` command (ansible-collections/community.libvirt#142). community.routeros ~~~~~~~~~~~~~~~~~~ - api_info - add new ``include_read_only`` option to select behavior for read-only values. By default these are not returned (ansible-collections/community.routeros#213). - api_info, api_modify - add support for ``address-list`` and ``match-subdomain`` introduced by RouterOS 7.7 in the ``ip dns static`` path (ansible-collections/community.routeros#197). - api_info, api_modify - add support for ``user``, ``time`` and ``gmt-offset`` under the ``system clock`` path (ansible-collections/community.routeros#210). - api_info, api_modify - add support for the ``interface ppp-client`` path (ansible-collections/community.routeros#199). - api_info, api_modify - add support for the ``interface wireless`` path (ansible-collections/community.routeros#195). - api_info, api_modify - add support for the ``iot modbus`` path (ansible-collections/community.routeros#205). - api_info, api_modify - add support for the ``ip dhcp-server option`` and ``ip dhcp-server option sets`` paths (ansible-collections/community.routeros#223). - api_info, api_modify - add support for the ``ip upnp interfaces``, ``tool graphing interface``, ``tool graphing resource`` paths (ansible-collections/community.routeros#227). - api_info, api_modify - add support for the ``ipv6 firewall nat`` path (ansible-collections/community.routeros#204). - api_info, api_modify - add support for the ``mode`` property in ``ip neighbor discovery-settings`` introduced in RouterOS 7.7 (ansible-collections/community.routeros#198). - api_info, api_modify - add support for the ``port remote-access`` path (ansible-collections/community.routeros#224). - api_info, api_modify - add support for the ``routing filter rule`` and ``routing filter select-rule`` paths (ansible-collections/community.routeros#200). - api_info, api_modify - add support for the ``routing table`` path in RouterOS 7 (ansible-collections/community.routeros#215). - api_info, api_modify - add support for the ``tool netwatch`` path in RouterOS 7 (ansible-collections/community.routeros#216). - api_info, api_modify - add support for the ``user settings`` path (ansible-collections/community.routeros#201). - api_info, api_modify - add support for the ``user`` path (ansible-collections/community.routeros#211). - api_info, api_modify - finalize fields for the ``interface wireless security-profiles`` path and enable it (ansible-collections/community.routeros#203). - api_info, api_modify - finalize fields for the ``ppp profile`` path and enable it (ansible-collections/community.routeros#217). - api_modify - add new ``handle_read_only`` and ``handle_write_only`` options to handle the module's behavior for read-only and write-only fields (ansible-collections/community.routeros#213). - api_modify, api_info - support API paths ``routing id``, ``routing bgp connection`` (ansible-collections/community.routeros#220). community.vmware ~~~~~~~~~~~~~~~~ - add moid property in the return value for the module(ansible-collections/community.vmware#1855). - add new snapshot_id option to the vmware_guest_snapshot module(ansible-collections/community.vmware#1847). dellemc.powerflex ~~~~~~~~~~~~~~~~~ - Added Ansible role to support installation and uninstallation of Gateway. - Added Ansible role to support installation and uninstallation of SDR. - Added Ansible role to support installation and uninstallation of Web UI. grafana.grafana ~~~~~~~~~~~~~~~ - Add check for Curl and failure step if Agent Version is not retrieved - Allow alert resource provisioning in Grafana Role - Bump cryptography from 39.0.2 to 41.0.3 - Bump cryptography from 41.0.3 to 41.0.4 - Bump semver from 5.7.1 to 5.7.2 - Bump word-wrap from 1.2.3 to 1.2.5 - Create local dashboard directory in check mode - Create missing notification directory in Grafana Role - Remove check_mode from create local directory task in Grafana Role - Remove dependency on local-fs.target from Grafana Agent role - Update CI Testing - Update Cloud Stack Module failures - Use 'ansible_system' env variable to detect os typ in Grafana Agent Role - hange grafana Agent Wal and Positions Directory in Grafana Agent Role ovirt.ovirt ~~~~~~~~~~~ - ovirt_vm - Add tpm_enabled (oVirt/ovirt-ansible-collection#722). - storage_error_resume_behaviour - Support VM storage error resume behaviour "auto_resume", "kill", "leave_paused". (oVirt/ovirt-ansible-collection#721) - vm_infra - Support boot disk renaming and resizing. (oVirt/ovirt-ansible-collection#705) purestorage.flashblade ~~~~~~~~~~~~~~~~~~~~~~ - purefb_bucket_replica - Added support for cascading replica links - purefb_info - New fields to display free space (remaining quota) for Accounts and Buckets. Space used by destroyed buckets is split out from virtual field to new destroyed_virtual field - purefb_info - Report encryption state in SMB client policy rules - purefb_info - Report more detailed space data from Purity//FB 4.3.0 - purefb_policy - Add deny effect for object store policy rules. Requires Purity//FB 4.3.0+ - purefb_policy - Added parameter to define object store policy description vultr.cloud ~~~~~~~~~~~ - inventory - Added VPC/VPC 2.0 support by adding ``internal_ip`` to the attributes (vultr/ansible-collection-vultr#86).

* Changing EnableSecureBoot to SetSecureBoot * Sanity Fix * Adding changelog fragment * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> * Updating PR to just add SetSecureBoot command * Update plugins/modules/redfish_config.py Agreed Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Kushal <[email protected]> Co-authored-by: Felix Fontein <[email protected]>

ansibullbot added feature This issue/PR relates to a feature request module module module_utils module_utils plugins plugin (any type) labels Aug 18, 2023

This comment was marked as outdated.

Sign in to view

felixfontein added backport-7 check-before-release PR will be looked at again shortly before release and merged if possible. labels Aug 18, 2023

felixfontein reviewed Aug 18, 2023

View reviewed changes

plugins/modules/redfish_config.py Outdated Show resolved Hide resolved

mraineri reviewed Aug 18, 2023

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Aug 27, 2023

This comment was marked as outdated.

Sign in to view

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed stale_ci CI is older than 7 days, rerun before merging labels Sep 20, 2023

TSKushalHPE and others added 5 commits September 20, 2023 22:04

Changing EnableSecureBoot to SetSecureBoot

a4b45f7

Sanity Fix

24014a8

Adding changelog fragment

00d36f0

Update plugins/modules/redfish_config.py

ae0b925

Agreed Co-authored-by: Felix Fontein <[email protected]>

Updating PR to just add SetSecureBoot command

c5b6f75

TSKushal force-pushed the set_secure_boot branch from 43f04d3 to c5b6f75 Compare September 20, 2023 16:34

TSKushal changed the title ~~Changing EnableSecureBoot to SetSecureBoot~~ Adding SetSecureBoot to redfish_config Sep 20, 2023

ansibullbot removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Sep 20, 2023

felixfontein reviewed Sep 20, 2023

View reviewed changes

plugins/modules/redfish_config.py Outdated Show resolved Hide resolved

Update plugins/modules/redfish_config.py

3ce58a4

Agreed Co-authored-by: Felix Fontein <[email protected]>

felixfontein merged commit 12b48aa into ansible-collections:main Sep 20, 2023
144 checks passed

patchback bot mentioned this pull request Sep 20, 2023

[PR #7129/12b48aaa backport][stable-7] Adding SetSecureBoot to redfish_config #7298

Merged

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Sep 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding SetSecureBoot to redfish_config #7129

Adding SetSecureBoot to redfish_config #7129

TSKushal commented Aug 18, 2023

ansibullbot commented Aug 18, 2023

This comment was marked as outdated.

felixfontein left a comment

mraineri Aug 18, 2023

TSKushal Sep 1, 2023

mraineri Sep 1, 2023

mraineri Sep 1, 2023

felixfontein Sep 1, 2023

TSKushal Sep 20, 2023

This comment was marked as outdated.

mraineri commented Sep 20, 2023

felixfontein commented Sep 20, 2023

TSKushal commented Sep 20, 2023

patchback bot commented Sep 20, 2023 •

edited

Loading

felixfontein commented Sep 20, 2023

Adding SetSecureBoot to redfish_config #7129

Adding SetSecureBoot to redfish_config #7129

Conversation

TSKushal commented Aug 18, 2023

ansibullbot commented Aug 18, 2023

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

mraineri Aug 18, 2023

Choose a reason for hiding this comment

TSKushal Sep 1, 2023

Choose a reason for hiding this comment

mraineri Sep 1, 2023

Choose a reason for hiding this comment

mraineri Sep 1, 2023

Choose a reason for hiding this comment

felixfontein Sep 1, 2023

Choose a reason for hiding this comment

TSKushal Sep 20, 2023

Choose a reason for hiding this comment

This comment was marked as outdated.

mraineri commented Sep 20, 2023

felixfontein commented Sep 20, 2023

TSKushal commented Sep 20, 2023

patchback bot commented Sep 20, 2023 • edited Loading

Backport to stable-7: 💚 backport PR created

felixfontein commented Sep 20, 2023

patchback bot commented Sep 20, 2023 •

edited

Loading