redhat_subscription module broken with RHEL 9

[dkolepp]

Summary

When I try to ensure that a system does not have a subscription active, I get a failed task for a RHEL 9 system.

Example:

- name: Ensure system subscription is absent
  redhat_subscription:
    state: absent
    activationkey: "{{ sat_activationkey }}"
    org_id: "{{ sat_organization }}"

fails for a RHEL9 host.

Issue Type

Bug Report

Component Name

redhat_subscription

Ansible Version

$ ansible --version

Community.general Version

$ ansible-galaxy collection list community.general
Collection        Version
----------------- -------
community.general 5.0.0  

Configuration

$ ansible-config dump --only-changed

OS / Environment

RHEL 9

Steps to Reproduce

- name: Ensure system subscription is absent
  redhat_subscription:
    state: absent
    activationkey: "{{ sat_activationkey }}"
    org_id: "{{ sat_organization }}"

for a RHEL9 host, the task fails:

fatal: [servera]: FAILED! => {"changed": false, "cmd": "/sbin/subscription-manager unsubscribe --all", "msg": "", "rc": 1, "stderr": "", "stderr_lines": [], "stdout": "Usage: subscription-manager MODULE-NAME [MODULE-OPTIONS] [--help]\n\r\nPrimary Modules: \n\n  attach         Attach a specified subscription to the registered system, when system does not use Simple Content Access mode\n  list           List subscription and product information for this system\n  refresh        Pull the latest subscription data from the server\n  register       Register this system to the Customer Portal or another subscription management service\n  release        Configure which operating system release to use\n  remove         Remove all or specific subscriptions from this system\n  status         Show status information for this system's subscriptions and products\n  unregister     Unregister this system from the Customer Portal or another subscription management service\n\nOther Modules:   \n\n  addons         Deprecated, see 'syspurpose'\n  auto-attach    Set if subscriptions are attached on a schedule (default of daily)\n  clean          Remove all local system and subscription data without affecting the server\n  config         List, set, or remove the configuration parameters in use by this system\n  environments   Display the environments available for a user\n  facts          View or update the detected system information\n  identity       Display the identity certificate for this system or request a new one\n  import         Import certificates which were provided outside of the tool\n  orgs           Display the organizations against which a user can register a system\n  plugins        View and configure with 'subscription-manager plugins'\n  redeem         Attempt to redeem a subscription for a preconfigured system\n  repo-override  Manage custom content repository settings\n  repos          List the repositories which this system is entitled to use\n  role           Deprecated, see 'syspurpose'\n  service-level  Deprecated, see 'syspurpose'\n  syspurpose     Convenient module for managing all system purpose settings\n  usage          Deprecated, see 'syspurpose'\n  version        Print version information\n\n", "stdout_lines": ["Usage: subscription-manager MODULE-NAME [MODULE-OPTIONS] [--help]", "", "Primary Modules: ", "", "  attach         Attach a specified subscription to the registered system, when system does not use Simple Content Access mode", "  list           List subscription and product information for this system", "  refresh        Pull the latest subscription data from the server", "  register       Register this system to the Customer Portal or another subscription management service", "  release        Configure which operating system release to use", "  remove         Remove all or specific subscriptions from this system", "  status         Show status information for this system's subscriptions and products", "  unregister     Unregister this system from the Customer Portal or another subscription management service", "", "Other Modules:   ", "", "  addons         Deprecated, see 'syspurpose'", "  auto-attach    Set if subscriptions are attached on a schedule (default of daily)", "  clean          Remove all local system and subscription data without affecting the server", "  config         List, set, or remove the configuration parameters in use by this system", "  environments   Display the environments available for a user", "  facts          View or update the detected system information", "  identity       Display the identity certificate for this system or request a new one", "  import         Import certificates which were provided outside of the tool", "  orgs           Display the organizations against which a user can register a system", "  plugins        View and configure with 'subscription-manager plugins'", "  redeem         Attempt to redeem a subscription for a preconfigured system", "  repo-override  Manage custom content repository settings", "  repos          List the repositories which this system is entitled to use", "  role           Deprecated, see 'syspurpose'", "  service-level  Deprecated, see 'syspurpose'", "  syspurpose     Convenient module for managing all system purpose settings", "  usage          Deprecated, see 'syspurpose'", "  version        Print version information", ""]}

Expected Results

I expected this to unsubscribe the host.

Actual Results

  "stdout_lines": [
    "Usage: subscription-manager MODULE-NAME [MODULE-OPTIONS] [--help]",
    "",
    "Primary Modules: ",
    "",
    "  attach         Attach a specified subscription to the registered system, when system does not use Simple Content Access mode",
    "  list           List subscription and product information for this system",
    "  refresh        Pull the latest subscription data from the server",
    "  register       Register this system to the Customer Portal or another subscription management service",
    "  release        Configure which operating system release to use",
    "  remove         Remove all or specific subscriptions from this system",
    "  status         Show status information for this system's subscriptions and products",
    "  unregister     Unregister this system from the Customer Portal or another subscription management service",
    "",
    "Other Modules:   ",
    "",
    "  addons         Deprecated, see 'syspurpose'",
    "  auto-attach    Set if subscriptions are attached on a schedule (default of daily)",
    "  clean          Remove all local system and subscription data without affecting the server",
    "  config         List, set, or remove the configuration parameters in use by this system",
    "  environments   Display the environments available for a user",
    "  facts          View or update the detected system information",
    "  identity       Display the identity certificate for this system or request a new one",
    "  import         Import certificates which were provided outside of the tool",
    "  orgs           Display the organizations against which a user can register a system",
    "  plugins        View and configure with 'subscription-manager plugins'",
    "  redeem         Attempt to redeem a subscription for a preconfigured system",
    "  repo-override  Manage custom content repository settings",
    "  repos          List the repositories which this system is entitled to use",
    "  role           Deprecated, see 'syspurpose'",
    "  service-level  Deprecated, see 'syspurpose'",
    "  syspurpose     Convenient module for managing all system purpose settings",
    "  usage          Deprecated, see 'syspurpose'",
    "  version        Print version information",
    ""
  ]
}

This appears to happen because in RHEL 9, subscription-manager unsubscribe is not a valid command sequence. There is not unsubscribe sub-command (but there is, in RHEL 8).

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:
None

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

Files identified in the description:

• plugins/modules/packaging/os/redhat_subscription.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @alikins @barnabycourt @kahowell
click here for bot help

[kallies]

subscription-manager unsubscribe was marked as deprecated on RHEL 7 already. I assume the replacement should be

subscription-manager remove --all
subscription-manager unregister

[ptoscano]

subscription-manager developer here o/ Thanks for the ticket, I just opened #4809 for fixing this.

[benblasco]

Will this change to the module also cover unregistering the host altogether? I see that unsubscribe is replaced with remove according to the linked PR

The description of the state field for the module says:

options:
    state:
        description:
          - whether to register and subscribe (C(present)), or unregister (C(absent)) a system
        choices: [ "present", "absent" ]
        default: "present"
        type: str

As you can see state:absent should also unregister the system altogether, not just remove a subscription or set of subscriptions.

From the subscription-manager docs:
Unregister:

   UNREGISTER OPTIONS
       The  unregister  command removes a system's subscriptions and removes it from the subscription management ser‐
       vice.

       This command has no options.

Remove:

   REMOVE OPTIONS
       The remove command removes a subscription from the system. (This does not uninstall the associated products.)

[ptoscano]

Will this change to the module also cover unregistering the host altogether? I see that unsubscribe is replaced with remove according to the linked PR

The unsubscribe command of subscription-manager(1) has been a deprecated alias for the remove command, at least since RHEL 5.11. They used to do the very same operation, no changes. The issue is that unsubscribe was removed in subscription-manager 1.29.x, thus preventing this Ansible module to do some operations on RHEL 9.x. My PR merely switches to the non-deprecated command, i.e. remove: this is effectively a no-op change for a RHEL 8.x host and earlier, making the module work in RHEL 9.x.

From the subscription-manager docs: Unregister:

I'm not sure why you are looking at the documentation of unregister, which is a different command than unsubscribe/remove.

As you can see state:absent should also unregister the system altogether, not just remove a subscription or set of subscriptions.

Is this the case? If so, that would be a new issue to file, and something already broken before this issue (with my PR).