Meraki DataMagic - Managing Your Organizations

As an administrator, to create, view, delete, edit and manage your Organizations:

1. From the Admin menu, click Organizations
2. Filter, sort, view, and download Organizations you have added to DataMagic

Adding an Organization

To add an organization:

1. From the Admin menu, click Organizations.
2. Click the Create button.
3. Click Next on the wizard then in the Actions column of a valid Connection, click the green + button to select it, the click Next.
4. In the list of Available Organizations, in the Actions column, click the green + button to select it then click Next.
5. 
   When adding an Organization it is possible to set the network "Group" and "Allow" functions. These use NCalc on the Meraki Network object to emit:
• Network Group Function: A string to use to group Networks in the Estate Tree
• Example 1:
• 'Assigned'
• a fixed string
• the default
• Example 2:
• itemAtIndex(split(getProperty(network, 'Name'), '-'), 0)
• The first part of the network name, so for UK-London, this would emit "UK"
• Network Allow Function: A boolean to determine whether Networks should be included in DataMagic's processing
• Example 1:
• true
• All networks
• the default
• Example 2:
• contains(getProperty(network, 'Tags'), 'msp_managed')
• The tags contains one with the value "msp-managed")
• Useful when tagging best practices are in place
• Example 3:
• !contains(getProperty(network, 'Name'), 'TEST')
• Ignore any networks with "TEST" in the name
• Useful when network names are used to control environments
6. Click Next
7. The Organization is added.

Editing an Organization

To edit an organization:

1. From the Admin menu, click Organizations.
2. Click to select the required Organization (use the search box if needed).
3. Click Edit and in the dialog box that appears, amend as required, then click Save.

Note: the 'Collect Stats Interval secs' property in the edit form allows you to set a custom update interval to update 1) Switch Port statistics (such as the Rx / Tx data) and VPN Peers statistics (such as Max Jitter Last Hour / Max Latency Last Hour). Note that the value must be 300 (5 minutes) or greater, or you will see an error when saving the Organization. If you uncheck this option, thhe data will be still be collected but may not be as frequently and will just happen during regular device processing - and this depends upon how long the various Meraki API calls take to execute.

Sending alerts to AlertMagic

DataMagic can send an Organization's alerts to AlertMagic, for example when an appliance stops reporting, a WAN uplink goes down or a DHCP pool is nearly full. To turn this on, edit the Organization and add an AlertMagicNotifications section to its Configuration (JSON). DataMagic sends nothing until the Url, Username and Password are all set.

{
	"AlertMagicNotifications": {
		"Url": "the Notify address of your AlertMagic integration",
		"Username": "the name of the integration",
		"Password": "the integration's password",
		"DhcpThresholds": { "UtilizationPercent": 85 }
	}
}

Setting	What it does	Default
Url	The Notify address of the AlertMagic integration that receives the alerts.	Required
Username	The name of that AlertMagic integration.	Required
Password	The integration's password.	Required
Events	Which alerts to send, as a list of the alert IDs below. Leave it out to send every alert, or give an empty list to send none.	Every alert
WanThresholds	LatencyMs, LossPercent and JitterMs: the levels above which a WAN uplink's latency, packet loss and jitter alert. Each is optional.	150 ms, 5% and 50 ms
DhcpThresholds	UtilizationPercent: how full a DHCP pool must be to alert, above 5 and at most 100. The alert clears when the pool falls more than 5 points below it. Pools of fewer than 16 addresses never alert. See DHCP Pools.	90%

Alerts DataMagic can send

Alert ID	Sent when	Level
datamagic_appliance_stopped_reporting	An appliance stops reporting to Meraki.	critical
datamagic_appliance_started_reporting	An appliance starts reporting again.	informational
datamagic_switch_stopped_reporting	A switch stops reporting to Meraki.	critical
datamagic_switch_started_reporting	A switch starts reporting again.	informational
datamagic_configuration_change	A change appears in the Organization's Meraki change log.	informational
datamagic_device_history_change	A device's recorded details change.	informational
datamagic_wan_uplink_down	A WAN uplink fails or is disconnected.	critical
datamagic_wan_uplink_up	A failed WAN uplink comes back.	informational
datamagic_wan_uplink_latency_high, datamagic_wan_uplink_latency_ok	A WAN uplink's latency goes above its threshold, then back to or below it.	warning, informational
datamagic_wan_uplink_loss_high, datamagic_wan_uplink_loss_ok	A WAN uplink's packet loss goes above its threshold, then back to or below it.	warning, informational
datamagic_wan_uplink_jitter_high, datamagic_wan_uplink_jitter_ok	A WAN uplink's jitter goes above its threshold, then back to or below it.	warning, informational
datamagic_dhcp_pool_utilization_high	A DHCP pool reaches its threshold.	warning
datamagic_dhcp_pool_utilization_ok	A DHCP pool falls more than 5 points below its threshold, or stops being served.	informational

Note: AlertMagic acts on an alert only when the integration's configuration has an incident spec that matches it. A new type of alert does nothing there until a spec is added for it.

Network Inclusion Expression

The Network Inclusion Expression is an advanced feature that allows you to dynamically control which networks remain in DataMagic based on their properties. Unlike the Network Allow Function (which controls whether networks are initially added), the Network Inclusion Expression is evaluated continuously and can mark existing networks for deletion.

Key differences from Network Allow Function:

• Network Allow Function: Evaluated when networks are discovered. Networks that don't match are never added to DataMagic.
• Network Inclusion Expression: Evaluated continuously on existing networks. Networks that no longer match are marked for deletion and removed, along with all their associated data (clients, events, devices, etc.).

Behavior:

• When the expression returns false for a network, it is marked for deletion
• A background process (NetworkDeletionEngine) removes marked networks and all related data every 5 minutes
• If the expression is changed to return true for a previously excluded network, the network will be automatically re-added from Meraki on the next processing cycle
• If the expression fails to evaluate for a network (due to errors), the network's inclusion status remains unchanged
• Changes take effect on the next NetworkEngine loop, which may take several minutes depending on the number of networks

Available parameters:

• network - The full Meraki network object (as a JObject with all properties)
• network_id - The Meraki network ID
• network_name - The network name
• network_tags - The network tags as a list of strings

Examples:

• Example 1: Include all networks (default)
• true
• Example 2: Include only networks with a specific tag
• contains(network_tags, 'production')
• Only networks tagged with "production" will be retained
• Example 3: Exclude test networks
• !contains(network_name, 'Test')
• Networks with "Test" in the name will be removed
• Example 4: Complex condition
• contains(network_tags, 'monitored') && !startsWith(network_name, 'Lab-')
• Include only networks tagged "monitored" that don't start with "Lab-"

Warning: When a network is removed by the Network Inclusion Expression, all associated data is permanently deleted, including network clients, events, devices, VLANs, health data, and more. Use this feature carefully.

Downloading Organizations

Click Download to get an spreadsheet in XLSX format of your organizations (with API details redacted).

Removing an Organization

To remove an organization:

1. From the Admin menu, click Organizations.
2. Click to select the required Organization (use the search box if needed).
3. Click Edit and in the dialog box that appears, click Delete.
   You are asked if you are sure and to proceed with deletion, click Yes for the organization to be deleted. The deletion removed the Organization from DataMagic, and not from Meraki itself.