Greetings, Wow! Thanks for the heads up on this. It is kind of shockingly sparse... and I think the docs are being incorrectly published for that library as well. Anyway, I _think_ what the original author meant was for "dracclient" to be imported as "wsmanclient". The structure seems to match up with that. Looking at the existing code, it states "dracclient.client.DRACClient". That changed over four years ago so I think what you're viewing is a very old copy of the documentation that was once published in the openstack project namespace. As for where, I don't think it is presently being published, which makes this problem ultimately worse. I'm going to reach out to the maintainers and inquire if they can fix the larger issue of their docs publishing. Again, Thanks for the heads up. -Julia p.s. https://review.opendev.org/735674 On Mon, Jun 15, 2020 at 11:04 AM Ewan Hamilton <ewan.hamilton@managed.co.uk> wrote:

Hi guys,

Your documentation for python-dracclient begins here: https://docs.openstack.org/python-dracclient/latest/usage.html with

Usage

Create a client object by providing the connection details of the DRAC card:

client = wsmanclient.client.DRACClient('1.2.3.4', 'username', 's3cr3t')

There is no import statement – and when I have searched google and found “import dracclient” because the assumed “import python-dracclient” doesn’t work due to a hyphen (why would you name your module with a hyphen in the first place?!), it doesn’t recognise “wsmanclient” in the editor still.

Can you see just how frustrating this is for someone who expects documentation that actually works and explains how to actually use the module?

This is a pathetic job here.

Ewan Hamilton​ 3rd Line Networks Analyst t: 0800 033 4800 ext. *2212* <2212> | m: 07772 001 625 [image: LinkedIn] <https://www.linkedin.com/company/managed247-ltd/> [image: Twitter] <https://twitter.com/managed247> [image: Website] <http://www.managed.co.uk/> ​Technology House, 151 Silbury Boulevard, Milton Keynes, MK9 1LH managed. is a trading name of Managed247 Ltd ​Managed247 Ltd is a company registered in England and Wales under number 7019261

Hey Ewan, Good to meet you! We’re thrilled that you are looking at using python-dracclient to work with your Dell EMC servers. Python-dracclient was originally developed for use by the iDRAC driver in the Ironic project. The iDRAC driver documentation needed quite a bit of work as well, and I’m happy to say that we did overhaul it in a recent release. Since python-dracclient has been a library primarily used by Ironic, the documentation for it has been overlooked up to this point. We instead have focused on adding new features and functionality, as well as fixing the occasional bug in both python-dracclient and the Ironic iDRAC driver. As a result of your email, we’re looking at updating the documentation for python-dracclient in our upcoming release. In the meantime, there are some great opensource examples that use python-dracclient, which will hopefully be helpful to you as examples: * This is a simple utility that checks to see if the iDRAC is ready to receive commands: * https://github.com/dsp-jetpack/JetPack/blob/master/src/pilot/is_idrac_ready.... * Note that this “is ready?” check is built into python-dracclient, so it’s not something you will need to do in your code. You could replace the call to is_idrac_ready() in the example with another call though. * This is a utility that resets the iDRAC, clears the job queue, then configures the boot mode, boot device, iDRAC settings, and it will even optionally change the iDRAC password. Note that this script works in a tripleo environment, so it will need some tweaking if you want to use it stand-alone: * https://github.com/dsp-jetpack/JetPack/blob/master/src/pilot/config_idrac.py * This is a utility that discovers iDRACs in an IP range that you provide including discovering the service tag and server model: * https://github.com/dsp-jetpack/JetPack/blob/master/src/pilot/discover_nodes/... * And finally, the Ironic iDRAC driver makes extensive use of python-dracclient, but it is also probably the most complicated example: * https://github.com/openstack/ironic/tree/master/ironic/drivers/modules/drac As far as how python-dracclient originally got it’s name, I’m not really sure about that as we inherited the original repo from other developers who no longer work on the project. I suspect it was picked because it followed the naming conventions of at least some other library repos in OpenStack at that time. The WSManClient class is defined in https://github.com/openstack/python-dracclient/blob/master/dracclient/client..., and it is a class that is only used internally to python-dracclient. To use python-dracclient, you should only have to: from dracclient import client Then, you can call any method in the DRACClient class here: https://github.com/openstack/python-dracclient/blob/master/dracclient/client... If you want to view the python-dracclient code in a development environment editor, then you would need to modify the PYTHONPATH or equivalent in the dev environment to include the path to the directory containing python-dracclient/dracclient/client.py, and then it should be able to resolve everything. Feel free to reply on this list if you need a hand, or you can always email me directly. Thanks and happy hacking! Chris Dearborn Software Sr Principal Engr Dell EMC | Service Provider Engineering Christopher.Dearborn@Dell.com<mailto:Christopher.Dearborn@Dell.com> From: Ewan Hamilton <ewan.hamilton@managed.co.uk> Sent: Monday, June 15, 2020 1:43 PM To: openstack-discuss@lists.openstack.org Subject: python-dracclient [EXTERNAL EMAIL] Hi guys, Your documentation for python-dracclient begins here: https://docs.openstack.org/python-dracclient/latest/usage.html with Usage Create a client object by providing the connection details of the DRAC card: client = wsmanclient.client.DRACClient('1.2.3.4', 'username', 's3cr3t') There is no import statement – and when I have searched google and found “import dracclient” because the assumed “import python-dracclient” doesn’t work due to a hyphen (why would you name your module with a hyphen in the first place?!), it doesn’t recognise “wsmanclient” in the editor still. Can you see just how frustrating this is for someone who expects documentation that actually works and explains how to actually use the module? This is a pathetic job here. [cid:image001.png@01D6432D.E183F840] Ewan Hamilton​ 3rd Line Networks Analyst t: 0800 033 4800 ext. 2212<tel:2212> | m: 07772 001 625 [LinkedIn]<https://www.linkedin.com/company/managed247-ltd/> [Twitter]<https://twitter.com/managed247> [Website]<http://www.managed.co.uk/> ​Technology House, 151 Silbury Boulevard, Milton Keynes, MK9 1LH managed. is a trading name of Managed247 Ltd ​Managed247 Ltd is a company registered in England and Wales under number 7019261