# Meraki

# Introduction

The purpose of this plugin is to monitor meraki devices, appliance, switch and wireless.

The plugin connects with the rest api of Meraki, in order to obtain all the metrics.

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha-1" style="width: 56.5432%;"><tbody><tr><td style="width: 52%;">**Systems where tested**</td><td style="width: 48%;">Rocky linux, Fedora 34</td></tr><tr><td style="width: 52%;">**Systems where it works**</td><td style="width: 48%;">Any linux system</td></tr></tbody></table>

# Pre requisites

\- Connectivity to the endpoints provided by the API is required.  
\- A bearer token is required for authentication.  
\- Groups of agents must be defined as groups of agents, groups whose name contains the store code.  
\- The plugin server must be enabled in the environment.  
\- The dataserver must be enabled in the environment.

# Parameters

**Meraki connection parameters**

<table border="1" id="bkmrk---url-url-de-conexi%C3%B3"><colgroup><col></col><col></col></colgroup><tbody><tr><td>**--url**</td><td>API connection url, example : https://api.meraki.com/api/v1 . Default: https://api.meraki.com/api/v1</td></tr><tr><td>**--token**</td><td>Token bearer required for authentication</td></tr><tr><td>**--id**</td><td>Store ID, which will identify if the group exists in Pandora and will create the agent in it, and if the network exists in Meraki.</td></tr><tr><td>**--organization**</td><td>ID of the organization in which the networks will be scanned.</td></tr><tr><td>**--timespan**</td><td>Monitoring interval for switch port statistics.</td></tr></tbody></table>

**Parámetros configuración Pandora**

<table border="1" id="bkmrk---agent_name-nombre-" style="width: 62.8395%; height: 357.563px;"><colgroup><col style="width: 27.112%;"></col><col style="width: 72.4951%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--agent\_prefix**  
</td><td style="height: 29.7969px;">Prefix for all agents created by the plugin  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--module\_prefix**</td><td style="height: 29.7969px;">Prefix for all modules created by the plugin</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--location**</td><td style="height: 29.7969px;">Secondary groups added to the agent</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--interval**</td><td style="height: 29.7969px;">Agent monitoring interval</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--temporal**</td><td style="height: 29.7969px;">PandoraFMS temporary directory</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--data\_dir**  
</td><td style="height: 29.7969px;">PandoraFMS Data Directory</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--group**</td><td style="height: 29.7969px;">Agent group.</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--transfer\_mode**  
</td><td style="height: 29.7969px;">Data transfer mode, local or tentacle</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--tentacle\_client**  
</td><td style="height: 29.7969px;">Tentacle client path, by default “tentacle\_client”.</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--tentacle\_opts**  
</td><td style="height: 29.7969px;">Additional tentacle options  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--tentacle\_port**  
</td><td style="height: 29.7969px;">Tentacle Port  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--tentacle\_address**  
</td><td style="height: 29.7969px;">tentacle IP</td></tr></tbody></table>

**Parámetros Extra**

<table border="1" id="bkmrk---scan_appliance-des" style="width: 68.2716%; height: 152.781px;"><colgroup><col style="width: 22.7848%;"></col><col style="width: 77.0344%;"></col></colgroup><tbody><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**--scan\_appliance**</td><td style="height: 46.5938px;">Disable scanning of appliance devices with 0. Default enabled to 1.</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--scan\_switch**</td><td style="height: 29.7969px;">Disable scanning of switch devices with 0. By default set to 1.</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**--scan\_wireless**</td><td style="height: 29.7969px;">Disable scanning of wireless devices with 0. Default enabled to 1.</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**--log\_file**</td><td style="height: 46.5938px;">Path where the log file will be saved, for example :  
/tmp/meraki\_logfile.txt  
</td></tr></tbody></table>

# Manual execution

The plugin execution format is as follows:

```
./pandora_meraki --id < id > --url < url > --token < token > --location < location > --organization < organization > --timespan < interval switch port data monitoring in seconds >
--module_prefix < module prefix > --agent_prefix < agent prefix >
[ --scan_appliance < 1 or 0 > ] [ --scan_switch < 1 or 0 > ] [ --scan_wireless < 1 or 0 > ]
[ --transfer_mode < local o tentacle > ] [ --tentacle_port < tentacle_port > ] [ --tentacle_address < tentacle_address > ] [ --tentacle_client < tentacle client path ] [ --tentacle_opts < tentacle extra options ]
[ --data_dir < data dir > ] [ --group < group > ] [ --temporal < temporary directory path > ] [ --interval < interval agent monitorings in seconds > ] [--log_file < log file >]
```

# Configuration in PandoraFMS

To configure the plugin in PandoraFMS, the following steps must be followed:

**1. Upload the plugin to PandoraFMS, for example in the following path:**

```
/usr/share/pandora_server/util/plugin
```

**2. Go to the plugins section and create a new one:**

[![imagen.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/VNOimagen.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/VNOimagen.png)

 **3. Name, description and timeout are added:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/scaled-1680-/image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/image.png)

**4. The path of the plugin is added to the command and the necessary parameters for its execution.**

<p class="callout info">For each parameter a macro must be configured, being the syntax of this macro the following : \_fieldx\_, being x the positional number of the parameter, for example in the following image we see the parameters that are mandatory, --id, --url, --token, --agent\_prefix, --localization and --tentacle\_address since all the others can be used with the default values.</p>

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/scaled-1680-/G2nimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/G2nimage.png)

**5. The above macros are configured, adding in each one the value of the parameter:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/scaled-1680-/3g0image.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/3g0image.png)

**6. Once configured, you should create a module in an agent that executes the plugin. In the modules menu of an agent we create a new plugin type module:**

[![imagen.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/503imagen.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/503imagen.png)

**7. In the module configuration menu, we name it, select the plugin configured before and click on “create”.**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/scaled-1680-/Fcbimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/Fcbimage.png)

**8. The agents will be created in the next execution of the plugin:**

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/scaled-1680-/oPIimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-02/oPIimage.png)

# Agents and modules generated by the plugin

Running the plugin with the monitoring of all types of device abilities will create the following agents:

- One agent for each appliance type device that exists in the network that matches the id entered by parameter, will be created in the specified groups, and will contain the IP.

<table border="1" id="bkmrk-%3C-prefijo-%3E%3C-nombre-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>&lt; prefix &gt;&lt; switch name &gt;</td></tr></tbody></table>

With the following modules

<table border="1" id="bkmrk-%3C-prefijo-modulo-%3Est" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>&lt; module prefix &gt;status</td><td>Device status, 1 if online, 0 otherwise.</td></tr><tr><td>&lt; module prefix &gt;perfScore</td><td>Indicates how busy the device is.</td></tr></tbody></table>

And one for each interface :

<table border="1" id="bkmrk-%3C-prefijo-modulo-%3E%3C-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>&lt; module prefix &gt;&lt; interface name &gt;</td><td> Interface status.</td></tr></tbody></table>

- One agent for each switch type device that exists in the network that matches the id entered by parameter, will be created in the specified groups, and will contain the IP.

<table border="1" id="bkmrk-%3C-prefijo-%3E%3C-nombre--1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>&lt; prefix &gt;&lt; switch name &gt;</td></tr></tbody></table>

With the following modules

<table border="1" id="bkmrk-%3C-prefijo-modulo-%3Est-1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>&lt; prefix module &gt;status</td><td>Device status, 1 if online, 0 otherwise.</td></tr></tbody></table>

And the following for each port:

<table border="1" id="bkmrk-portid%3A-%3C-port-id-%3E-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50.0618%;"></col><col style="width: 50.0618%;"></col></colgroup><tbody><tr><td>&lt; port ID &gt;\_ifOperStatus</td><td>1 if enabled, 0 if not enabled</td></tr><tr><td>&lt; port ID &gt;.ifInOctets</td><td>Total traffic sent in kb</td></tr><tr><td>&lt; port ID &gt;.T\_ifOutOctets</td><td>Total traffic received in kb</td></tr></tbody></table>

- An agent for each wireless device that exists in the network that matches the id entered by parameter, will be created in the specified groups, and will contain the IP

<table border="1" id="bkmrk-%3C-prefijo-%3E%3C-nombre--2" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>&lt; prefix &gt;&lt; name switch &gt;</td></tr></tbody></table>

With the following modules

<table border="1" id="bkmrk-%3C-prefijo-modulo-%3Est-2" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>&lt; module prefix &gt;status</td><td>Device status, 1 if online, 0 otherwise.</td></tr><tr><td>&lt; module prefix &gt;totalKbps</td><td>Kb of total last day usage</td></tr><tr><td>&lt; module prefix &gt;sentKbps</td><td>Kb of usage on the last day sent</td></tr><tr><td>&lt; module prefix &gt;receivedKbps</td><td>Kb of usage on the last day received</td></tr><tr><td>&lt; module prefix &gt;clientCount</td><td>Total customer connections</td></tr></tbody></table>