search

CiscoISE / ansible-ise

Official repository for Cisco's Ansible collection for ISE
https://ciscoise.github.io/ansible-ise/
GNU General Public License v3.0
45 stars 12 forks source link

Inaccurate documentation #54

Closed RyanMBess closed 3 weeks ago

RyanMBess commented 2 years ago

Seems a number of links in the documentation doesn't have all parameters marked as required. Here's an example https://docs.ansible.com/ansible/latest/collections/cisco/ise/endpoint_module.html#ansible-collections-cisco-ise-endpoint-module

Per the above link only ise_hostname, ise_password, ise_username are the only parameters needed to create and endpoint. Please update so we know what parameters are required to use this module (please do the same for all modules)

bvargasre commented 2 years ago

Hi @RyanMBess This problem will be mentioned to Cisco since they are the ones who provide us with the API documentation to generate the libraries, and it is expected to be solved in future versions.

RyanMBess commented 2 years ago

Thank you.

RyanMBess commented 2 years ago

Hi @bvargasre, How goes updating the documentation. In this example https://docs.ansible.com/ansible/latest/collections/cisco/ise/sgt_module.html#ansible-collections-cisco-ise-sgt-module you MUST have the value attribute populated or you will be unable to create the SGT. Per the link it's not a required field.

bvargasre commented 2 years ago

Cisco has been informed about the required problem, but we have not been provided with new documentation yet. # For the moment I updated the documentation of the required fields for the creation of an sgt from the sgt module. The change can be seen here https://ciscoise.github.io/ansible-ise/main/plugins/sgt_module.html#ansible-collections-cisco-ise-sgt-module The changes will be reflected in docs.ansible.com when Ansible releases a new version.

rlangus commented 1 year ago

All, I ran into this issue, also. I found the Cisco developer website that lists all required fields. I specifically used this link https://developer.cisco.com/docs/identity-services-engine/v1/#!selfregportal to create a self registered portal. The clincher for me was the settings.portSettings.authencationMethod field, which is a required UUID and not a text name.

Hopefully this will help others. The parent link is https://developer.cisco.com/docs/identity-services-engine/v1/ with the API reference being the source of field information.

fmunozmiranda commented 3 weeks ago

Closed due inactivity