search

vmware / powershell-module-for-vmware-cloud-foundation-password-management

PowerShell Module for VMware Cloud Foundation Password Management
https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-password-management/
BSD 2-Clause "Simplified" License
12 stars 9 forks source link

Parameters for Aria component functions #190

Closed colin-cs closed 7 months ago

colin-cs commented 7 months ago

Code of Conduct

Module Version

v1.8.0

Motivation

The Request-AriaLocalUserPasswordComplexity, Get-AriaLocalUserPasswordComplexity, Update-AriaLocalUserPasswordComplexity cmdlets all include a -product parameter to target the query to a specific Aria product, however there is no guidance what switch needs be used with the parameter to define the targeted product.

You can infer from examples that vra is for Aria Automation and vrni is for Aria Ops for Network (vrni is documented as its own parameter).

The documentation needs to provide the definitive list Aria products for the parameters. This can/will be confusing to the users of these cmdlets. Especially since the existing switches use older discontinued abbreviations.

Suggestion

Minimally, update documentation to include include definitive list of -product parameter switches that the cmdlet will accept.

Optimally, update the cmdlets to use more current switches that map to the Aria name conventions. This particular modifiication may not be practical for a variety of reasons at the moment.

tenthirtyam commented 7 months ago

Assigning to @sowjuec.

tenthirtyam commented 7 months ago

I've republished the docs and this issue is now resolved.

Please clear your cache. 😄

github-actions[bot] commented 6 months ago

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.