From e56ee65ca7499c38e4f82f2d3bd3c320488c642d Mon Sep 17 00:00:00 2001 From: Kevin Breit Date: Tue, 3 Sep 2019 10:04:39 -0500 Subject: [PATCH] Docs - Add Meraki to platform option list (#61651) (cherry picked from commit 54906a68fe9a6c7369ccc018e49f8a9c4a248484) --- .../rst/network/user_guide/platform_index.rst | 3 ++ .../network/user_guide/platform_meraki.rst | 39 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 docs/docsite/rst/network/user_guide/platform_meraki.rst diff --git a/docs/docsite/rst/network/user_guide/platform_index.rst b/docs/docsite/rst/network/user_guide/platform_index.rst index 300b8837c67..af8accd8069 100644 --- a/docs/docsite/rst/network/user_guide/platform_index.rst +++ b/docs/docsite/rst/network/user_guide/platform_index.rst @@ -20,6 +20,7 @@ Some Ansible Network platforms support multiple connection types, privilege esca platform_ios platform_ironware platform_junos + platform_meraki platform_netvisor platform_nos platform_nxos @@ -74,6 +75,8 @@ Settings by Platform +-------------------+-------------------------+-------------+---------+---------+----------+ | Lenovo ENOS | ``enos`` | ✓ | | | ✓ | +-------------------+-------------------------+-------------+---------+---------+----------+ +| Meraki | ``meraki`` | | | | ✓ | ++-------------------+-------------------------+-------------+---------+---------+----------+ | MikroTik RouterOS | ``routeros`` | ✓ | | | | +-------------------+-------------------------+-------------+---------+---------+----------+ | Nokia SR OS | ``sros`` | ✓ | | | ✓ | diff --git a/docs/docsite/rst/network/user_guide/platform_meraki.rst b/docs/docsite/rst/network/user_guide/platform_meraki.rst new file mode 100644 index 00000000000..612bb8aa841 --- /dev/null +++ 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