PRTG Manual: Cisco Meraki Network Health Sensor

The Cisco Meraki Network Health sensor monitors the health of Cisco Meraki network devices via the Cisco Meraki Dashboard API.

i_betaThis sensor is in beta status. The operating methods and the available settings are still subject to change. Do not expect that all functions work properly, or that this sensor works as expected at all.

Cisco Meraki Network Health Sensor

Cisco Meraki Network Health Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: Cisco Meraki Network Health
  • French: Cisco Meraki Network Health
  • German: Cisco Meraki Network Health
  • Japanese: Cisco Meraki Network Health
  • Portuguese: Cisco Meraki Network Health
  • Russian: Cisco Meraki Network Health
  • Simplified Chinese: Cisco Meraki Network Health
  • Spanish: Cisco Meraki Network Health

Remarks

  • This sensor requires that the Beta Sensors experimental feature is enabled.
  • This sensor requires credentials for Cisco Meraki in settings that are higher in the object hierarchy, for example, in the settings of the parent device.
  • This sensor requires that the access of an organization to the Cisco Meraki Dashboard API is enabled.
  • This sensor supports the IPv6 protocol.
  • This sensor has a very low performance impact.

Detailed Requirements

Requirement

Description

Enabled Beta Sensors experimental feature

This sensor requires that the Beta Sensors experimental feature of PRTG is enabled.

i_square_cyanFor more information, see the Knowledge Base: What are beta sensors and how can I use them?

Enabled organization API access

Cisco Meraki sensors require that the access of an organization to the Cisco Meraki Dashboard API is enabled. If the API access for an organization is disabled, you must enable it manually. For more information, see Cisco Meraki Dashboard API: Enable API Access.

i_round_blueThe API key inherits the permissions of the Cisco Meraki Dashboard Administrator account that was used to generate the API key.

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

PRTG looks for available networks.

i_round_blueThe settings that you select in the Add Sensor dialog are valid for all sensors that you create when you finish the dialog.

Cisco Meraki Specific

Setting

Description

Network

Select the networks that you want to monitor. PRTG creates one sensor for each network that you select.

i_round_blueEnable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • cisco
  • meraki

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

Cisco Meraki Specific

Cisco Meraki Specific

Cisco Meraki Specific

Setting

Description

Network

Shows the name of the network that this sensor monitors.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Organization

Shows the name of the organization that the monitored network belongs to.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

i_round_blueThe minimum scanning interval of this sensor is 10 seconds.

i_round_blueThe recommended scanning interval of this sensor is 5 minutes.

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

i_round_blueWhich channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.

Channel Unit Configuration

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

IOT "Alerting"

IOT devices in alerting status

IOT "Dormant"

IOT devices in dormant status

IOT "Offline"

IOT devices in offline status

IOT "Online"

IOT devices in online status

MR "Alerting"

Meraki Radios (MR) devices in alerting status

MR "Dormant"

MR devices in dormant status

MR "Offline"

MR devices in offline status

MR "Online"

MR devices in online status

MS "Alerting"

Meraki Switching (MS) devices in alerting status

MS "Dormant"

MS devices in dormant status

MS "Offline"

MS devices in offline status

MS "Online"

MS devices in online status

MX "Alerting"

Meraki Security (MX) devices in alerting status

MX "Dormant"

MX devices in dormant status

MX "Offline"

MX devices in offline status

MX "Online"

MX devices in online status

Uplinks "Active"

Uplinks in active status

i_round_blueThis channel is the primary channel by default.

Uplinks "Failed"

Uplinks in failed status

Uplinks "Not Connected"

Uplinks in not connected status

Uplinks "Ready"

Uplinks in ready status

More

i_square_blueKnowledge Base

What are beta sensors and how can I use them?

What security features does PRTG include?