Skip to content

Commit

Permalink
update docs for v2.20.3
Browse files Browse the repository at this point in the history
  • Loading branch information
fmunozmiranda committed Jan 7, 2025
1 parent 7b89312 commit 9ef91b8
Show file tree
Hide file tree
Showing 1,257 changed files with 1,485,771 additions and 0 deletions.
1 change: 1 addition & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ <h1>Meraki Ansible Actions</h1>

<div class="row plugin-manual">
<div class="col-md-4 center"><a href="main/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>main</p></a></div>
<div class="col-md-4 center"><a href="v2.20.3/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>v2.20.3</p></a></div>
<div class="col-md-4 center"><a href="v2.20.1/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>v2.20.1</p></a></div>
<div class="col-md-4 center"><a href="v2.20.0/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>v2.20.0</p></a></div>
<div class="col-md-4 center"><a href="v2.18.2/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>v2.18.2</p></a></div>
Expand Down
4 changes: 4 additions & 0 deletions v2.20.3/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 19becea3a221e7579a69631c1dc55986
tags: 645f666f9bcd5a90fca523b33c5a78b7
21 changes: 21 additions & 0 deletions v2.20.3/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. DNA Center Ansible Actions documentation main file, created by
sphinx-quickstart on Tue Dec 12 10:00:39 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Meraki Ansible Actions documentation!
=====================================================

.. toctree::
:maxdepth: 2
:caption: User documentation

plugins/index
platform_meraki


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
71 changes: 71 additions & 0 deletions v2.20.3/_sources/platform_meraki.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.. _meraki_platform_options:

***************************************
Meraki Platform Options
***************************************

The `cisco.meraki <https://galaxy.ansible.com/ui/repo/published/cisco/meraki>`_ collection only supports the ``local`` connection type at this time.

.. contents::
:local:

Connections available
================================================================================

.. table::
:class: documentation-table

==================== ==========================================
.. Dashboard API
==================== ==========================================
Protocol HTTP(S)

Credentials uses API key from Dashboard

Connection Settings ``ansible_connection: localhost``

Returned Data Format ``data.``
==================== ==========================================


Example Meraki task
-------------------

.. code-block:: yaml

cisco.meraki.meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: present
delegate_to: localhost

For modules that do not have the "meraki" prefix, this is an example that you can use as a guide

.. code-block:: yaml

cisco.meraki.administered_identities_me_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
register: result

.. seealso::

:ref:`timeout_options`
Loading

0 comments on commit 9ef91b8

Please sign in to comment.