New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Meraki scenario guide #41827
Meraki scenario guide #41827
Conversation
This comment has been minimized.
This comment has been minimized.
|
||
Meraki modules provide a user-friendly interface to manage your Meraki environment using Ansible. For example, details about SNMP settings for a particular organization can be discovered using the module `meraki_snmp <meraki_snmp_module>`. | ||
|
||
.. code_block:: yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Try this maybe ?
::
- name: Query SNMP settings
meraki_snmp:
api_key: abc123
org_name: AcmeCorp
state: query
delegate_to: localhost
I couldn't find any instance of code_block
by grepping the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unscores and dashes are important.
- Added very common parameters everyone uses. - Documented common format for returned data from Meraki. - High level explanation of error handling.
This comment has been minimized.
This comment has been minimized.
I don't know how I missed this. Should we merge this and backport this to v2.7 ? |
We should. I am going to review it and make sure it's good before we merge and backport though. I should be able to do it in a day or two. |
@dagwieers Okay lets merge this and I’ll get a back port into 2.7. |
|
||
Meraki and its related Ansible modules return most information in the form of a list. For example, this is returned information by ``meraki_admin`` querying administrators. It returns a list even though there's only one. | ||
|
||
.. code-block:: yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make this 'json' instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm trying to do this in the backport and really struggling. Is json not a valid option or do I need to include quotes?
* Initial commit for the Meraki scenario guide * Added Meraki guide to indexes, fixed an error * Added common parameters to scenario guide * Add additional information for first draft - Added very common parameters everyone uses. - Documented common format for returned data from Meraki. - High level explanation of error handling. * Fix .rst formatting error * Added section about handling returned data. More to come. * Small formatting changes (cherry picked from commit ec3ce1f)
SUMMARY
A scenario guide for the Meraki modules will provide the following benefits:
ISSUE TYPE
COMPONENT NAME
meraki