dsccommunity / WSManDsc

DSC resources for configuring WS-Management and PowerShell Remoting.
https://dsccommunity.org
MIT License
19 stars 8 forks source link

WSManListener parameter DN should be BaseDN #89

Open lamawithonel opened 3 years ago

lamawithonel commented 3 years ago

In X.500 parlance, the Distinguished Name (DN) is the fully-qualified object path.1,2 For example, CN=example.com, O=IANA, C=US is a DN. In the WSManListener resource, however, the DN parameter specifies only the path part, O=IANA, C=US, better known as the Base DN.2,3 Misnamed parameters like this create cognitive dissonance and poor usability. The documentation should be updated to note that it references the Base DN, not a DN, and the parameter name should be updated to BaseDN.

On a personal note/to give a real-world example, this has cost me time and frustration. I initially ignored the parameter because of the documentation, but when it didn't work I had to trace the code to find the problem. It's difficult for me to submit patches due to my job's legal requirements, but let me know if you have any questions.