Unable to view credentials via API or slcli for an HSM Device

[akkowals]

Please triple-check to make sure that you have properly masked out user credentials like usernames, passwords and API keys before submitting your issue

Hi,

I have ordered a Hardware Security Module (HSM) from SoftLayer and trying to build automation around interacting with it. In the UI, I can view the "passwords" section to view the initially set "hsm_admin" credentials. I cannot, however, view that same information via the API or slcli. If I attempt to view the credentials for the HSM device via slcli I encounter the following stacktrace suggesting I open an issue here.

drews-mbp-2:ms-job akkowals$ slcli hardware credentials 1537051
An unexpected error has occured:
Traceback (most recent call last):
  File "/Library/Python/2.7/site-packages/SoftLayer/CLI/core.py", line 163, in main
    cli.main(**kwargs)
  File "/Library/Python/2.7/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/Library/Python/2.7/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/Library/Python/2.7/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/Library/Python/2.7/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Library/Python/2.7/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/Library/Python/2.7/site-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/Library/Python/2.7/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/Library/Python/2.7/site-packages/SoftLayer/CLI/hardware/credentials.py", line 25, in cli
    for item in instance['operatingSystem']['passwords']:
KeyError: 'passwords'

Feel free to report this error as it is likely a bug:
    https://github.com/softlayer/softlayer-python/issues

Further clarification: I found this git issue #981 but the fix there appears to be just not failing with a stacktrace (instead raise an exception) if passwords don't get returned by the API...Are HSM credentials not allowed to be obtainable via API or slcli?

Expected Behavior

I expected to be able to view the operating system passwords like other devices (VSIs, baremetals etc) so I can automate tasks related to the HSM.

Actual Behavior

The API does not return a "passwords" section for the "SoftLayer_Software_Component_OperatingSystem" datatype even when the mask used specifies it. slcli likely hits the same issue.

Environment Information

Operating System: macOS High Sierra 10.13.6
softlayer-python version (slcli --version): slcli (SoftLayer Command-line), version 5.3.2

[allmightyspiff]

I THINK HSM passwords are stored in the softwareComponents relation, not the operatingSystem relation, but let me double check. If thats the case, we might need to update the slcli to support that. We are checking now.

[akkowals]

Ah, yes! I just confirmed I can see the passwords for my HSM if I change to use the softwareComponents relation. Thanks for pointing that out @allmightyspiff . Yeah that would be great if the CLI could be updated to account for HSM differences like that. My team mainly depends on the API rather than the CLI so I am happy that the API has it available somewhere at least.

[allmightyspiff]

This is currently working in the master branch, and will be part of the v5.5.2 release