Docs - Add Meraki to platform option list (#61651)

5 years ago · 54906a68fe
parent ca3078de5f
commit 54906a68fe
2 changed files with 41 additions and 0 deletions
--- a/docs/docsite/rst/network/user_guide/platform_index.rst
+++ b/docs/docsite/rst/network/user_guide/platform_index.rst
@ -23,6 +23,7 @@ Some Ansible Network platforms support multiple connection types, privilege esca
   platform_iosxr
   platform_ironware
   platform_junos
+   platform_meraki
   platform_netvisor
   platform_nos
   platform_nxos
@ -75,6 +76,7 @@ Settings by Platform
    Junos OS `[†]`_                  ``junos``                ✓            ✓                 ✓
    Lenovo CNOS                      ``cnos``                 ✓                              ✓
    Lenovo ENOS                      ``enos``                 ✓                              ✓
+    Meraki                           ``meraki``                                              ✓
    MikroTik RouterOS                ``routeros``             ✓
    Nokia SR OS                      ``sros``                 ✓                              ✓
    Pluribus Netvisor                ``netvisor``             ✓
--- a/docs/docsite/rst/network/user_guide/platform_meraki.rst
+++ b/docs/docsite/rst/network/user_guide/platform_meraki.rst
@ -0,0 +1,39 @@
+.. _meraki_platform_options:
+
+***************************************
+Meraki Platform Options
+***************************************
+
+Meraki only support supports the ``local`` connection type at this time.
+
+.. contents:: Topics
+
+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
+
+  meraki_organization:
+    auth_key: abc12345
+    org_name: YourOrg
+    state: present
+  delegate_to: localhost