Merge ~troyanov/maas:backport-f06ea63-3.4 into maas:3.4

[Anton Troyanov]

LP:2040188 - bmc-config: add missing script metadata for parameter maas_auto_ipmi_cipher_suite_id

The bmc-config script is passed several parameters from MAAS config options
(e.g. maas_auto_ipmi_{user,user_password,user_privilege_level,k_g_bmc_key}).

But maas_auto_ipmi_cipher_suite_id is not, since it's not in the metadata.

Add it to actually allow users to change the default IPMI cipher suite ID.

Tested on MAAS 3.4.0~rc2 with this debug change to print script arguments:

         def main():
         ...
             args = parser.parse_args()
        + print(args)
         ...

Change MAAS config for IPMI cipher suite ID from 3 to 17:

        $ maas admin maas get-config \
          name=maas_auto_ipmi_cipher_suite_id
        Success.
        Machine-readable output follows:
        "3"

        $ maas admin maas set-config \
          name=maas_auto_ipmi_cipher_suite_id \
          value=17
        Success.
        Machine-readable output follows:
        OK

        $ maas admin maas get-config \
          name=maas_auto_ipmi_cipher_suite_id
        Success.
        Machine-readable output follows:
        "17"

Before:
(17 is not used; source code default of 3 is used, instead)

        Namespace(ipmi_cipher_suite_id='3', ipmi_k_g='', ipmi_privilege_level='ADMIN', password=None, username='maas')

After:
(17 is now used!)

        Namespace(ipmi_cipher_suite_id='17', ipmi_k_g='', ipmi_privilege_level='ADMIN', password=None, username='maas')

Found by comparison with (working) parameter maas_auto_ipmi_user:

        $ grep -r 'maas_auto_ipmi_user[^_]' | grep -vw -e maasui -e maas-offline-docs -e tests
        src/metadataserver/builtin_scripts/commissioning_scripts/bmc_config.py:# maas_auto_ipmi_user:
        src/maasserver/forms/settings.py: "maas_auto_ipmi_user": {
        src/maasserver/forms/parameters.py: "maas_auto_ipmi_user",
        src/maasserver/models/config.py: "maas_auto_ipmi_user": "maas",

        $ grep -r 'maas_auto_ipmi_cipher_suite_id[^_]' | grep -vw -e maasui -e maas-offline-docs -e tests
        src/maasserver/forms/settings.py: "maas_auto_ipmi_cipher_suite_id": {
        src/maasserver/forms/parameters.py: "maas_auto_ipmi_cipher_suite_id",
        src/maasserver/models/config.py: "maas_auto_ipmi_cipher_suite_id": "3",

Signed-off-by: Mauricio Faria de Oliveira <email address hidden>
(cherry picked from commit f06ea636a9466176d29d71e1539c65d7538f41da)

[MAAS Lander (maas-lander)]

UNIT TESTS
-b backport-f06ea63-3.4 lp:~troyanov/maas/+git/maas into -b 3.4 lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 90bad52d61ce06b4ff4a0e72466a5eb643c496cf

review: Approve

[Adam Collard (adam-collard)]

review: Approve

[Adam Collard (adam-collard)]

review: Abstain

[Anton Troyanov (troyanov)]

Self approving backport

review: Approve

diff --git a/src/metadataserver/builtin_scripts/commissioning_scripts/bmc_config.py b/src/metadataserver/builtin_scripts/commissioning_scripts/bmc_config.py
index 38ba140..cfaa80d 100755
--- a/src/metadataserver/builtin_scripts/commissioning_scripts/bmc_config.py
+++ b/src/metadataserver/builtin_scripts/commissioning_scripts/bmc_config.py
@@ -46,6 +46,10 @@
 #       - [OPERATOR, Operator]
 #       - [ADMIN, Administrator]
 #     argument_format: --ipmi-privilege-level={input}
+#   maas_auto_ipmi_cipher_suite_id:
+#     type: string
+#     max: 2
+#     argument_format: --ipmi-cipher-suite-id={input}
 # packages:
 #   apt:
 #     - freeipmi-tools