Skip to content
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

Merged
merged 7 commits into from Sep 10, 2018
Merged

Meraki scenario guide #41827

merged 7 commits into from Sep 10, 2018

Conversation

kbreit
Copy link
Contributor

@kbreit kbreit commented Jun 22, 2018

SUMMARY

A scenario guide for the Meraki modules will provide the following benefits:

  • Explain what can be done with the modules
  • Provide inspiration for what can be done programmatically with Meraki
  • Explain limitations of the API and modules
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

meraki

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.7 This issue/PR affects Ansible v2.7 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jun 22, 2018
@ansibot

This comment has been minimized.

@s-hertel s-hertel removed the needs_triage Needs a first human triage before being processed. label Jun 22, 2018

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
Copy link
Contributor

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.

Copy link
Contributor Author

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.

@kbreit kbreit changed the title [WIP] Initial commit for the Meraki scenario guide Meraki scenario guide Jul 8, 2018
- Added very common parameters everyone uses.
- Documented common format for returned data from Meraki.
- High level explanation of error handling.
@ansibot ansibot removed the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Jul 8, 2018
@ansibot

This comment has been minimized.

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 8, 2018
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 8, 2018
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Jul 17, 2018
@ansibot
Copy link
Contributor

ansibot commented Aug 2, 2018

@dagwieers
Copy link
Contributor

I don't know how I missed this. Should we merge this and backport this to v2.7 ?

@kbreit
Copy link
Contributor Author

kbreit commented Sep 8, 2018

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.

@ansibot ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Sep 8, 2018
@kbreit
Copy link
Contributor Author

kbreit commented Sep 10, 2018

@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
Copy link
Contributor

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.

Copy link
Contributor Author

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?

@dagwieers dagwieers merged commit ec3ce1f into ansible:devel Sep 10, 2018
@kbreit kbreit deleted the meraki/scenario-guide branch September 11, 2018 15:13
@acozine acozine added this to To do in OLD Ansible Documentation via automation Sep 20, 2018
@dagwieers dagwieers moved this from To do to Done in OLD Ansible Documentation Sep 21, 2018
kbreit added a commit to kbreit/ansible that referenced this pull request Sep 25, 2018
* 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)
acozine pushed a commit that referenced this pull request Sep 26, 2018
* Meraki scenario guide (#41827)
(cherry picked from commit ec3ce1f)
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.7 This issue/PR affects Ansible v2.7 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants