WSManListener parameter DN should be BaseDN #89
Comments
lamawithonel
added a commit
to lamawithonel/WSManDsc
that referenced
this issue
Oct 4, 2021
In X.500 parlance, a _Distinguished Name_ (_DN_) is a fully-qualified object path<sup>[1][1],[2][2]</sup> For example, `CN=example.com, O=IANA, C=US` is a DN. Prior to this, however, the `DN` parameter did not specify the fully-qualified DN, but instead only the path part, minus the _Common Name_. In the above example, that would be `O=IANA, C=US`, were the common name is `CN=example.com`. This path part is properly known as the _Base DN_.<sup>[2][2],[3][3]</sup> Therefore, this commit updates the documentation for the `DN` parameter with the appropriate names. Fixes dsccommunity#89 [1]: https://ldapwiki.com/wiki/Distinguished%20Names [2]: https://www.novell.com/documentation/extend5/Docs/help/Composer/books/LDAPGlossary.html [3]: https://ldapwiki.com/wiki/BaseDN
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In X.500 parlance, the Distinguished Name (DN) is the fully-qualified object path.1,2 For example,
CN=example.com, O=IANA, C=USis a DN. In the WSManListener resource, however, theDNparameter 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 toBaseDN.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.
The text was updated successfully, but these errors were encountered: