brocade / ansible

56 stars 33 forks source link

Brocade Module Parameters #84

Closed ta-osan closed 3 years ago

ta-osan commented 3 years ago

Hi,

Where is the documentation that supports the Brocade modules please? The example playbooks provide limited information regrading parameter support, or do the example playbooks outline all of the available parameters and the modules don't support the full range of options? For example:

Does this module also support all parameters found under the 'configure' command, e.g. R_A_TOV, Sequence Level Switching, etc? If yes, what format do the Ansible parameters take?

Thanks

daniel-chung-broadcom commented 3 years ago

Other than the specific attributes are mentioned to be using SSH as the underlying mechanism (these are documented in the readme portion), all other attributes supported for a given module would be mapped to the underlying REST implementation. The rest implementation is documented in the yang modeling. These models are available under

https://github.com/brocade/yang

For example, you can find "fabric" object under https://github.com/brocade/yang/blob/master/8.2.2/8.2.2c/brocade-fibrechannel-configuration.yang. And you can find attributes that belong to the fabric object. In case of 8.2.2, the only attribute under the fabric object is

  leaf insistent-domain-id-enabled {

Hope this clarifies. Please let me know if you have additional questions.

daniel-chung-broadcom commented 3 years ago

closing since the answer has been provided. Please reopen if additional questions.

ta-osan commented 3 years ago

Hi Daniel,

Sorry for the slow response

Am I correct in saying that it is not possible to fully 'configure' (e.g. R_A_TOV, E_D_TOV, etc) a SAN switch using the Ansible modules, but it is with the ansible-fos-command?

Will the Ansible modules continue to develop and will there be proper supplemental documentation in the Ansible format which includes supported parameters for a module?

Thanks

daniel-chung-broadcom commented 3 years ago

I believe that we have decent coverage of CLI configure with the Ansible modules already. If you have a list of things that you need coverage for, we can look up yang files to see which objects/attributes are used. If some are not found, you can request coverage by filing GitHub issues on this repo and we can follow up to see if we can address them.

As for using ansible-fos-command, that should provide full coverage for any CLI in general since it provides CLI wrapper function. One thing to remember is that dry run is not supported by the module. I do not support that repo and additional detailed questions should be directed to the repo.

Ansible modules will continue to develop and coverage expansion will generally be aligned with additional FOS REST implementations and community inputs. Thus the primary documentation will be the yang repo previously mentioned. If any exceptions - for example, some attributes covered through ssh - are/will be documented in the readme section of the current repo.

Please let me know if any additional questions.