Cisco Meraki Ta Setup

Cisco Meraki TA Setup Automation

Prerequisites

Workflow Overview

┌───────────┐   ┌────────────┐   ┌──────────────────┐   ┌───────────────┐
│ Preflight │ → │ Install TA │ → │ Configure inputs │ → │ Validate data │
└───────────┘   └────────────┘   └──────────────────┘   └───────────────┘

When to Activate

• Onboard a Meraki Dashboard organization through Splunk_TA_cisco_meraki.
• Configure Meraki API accounts, polling inputs, indexes, or dashboard macros.
• Diagnose missing Meraki data or empty companion dashboards.

Scope

This skill configures Splunk collection and dashboard prerequisites. It does not request API keys in chat, modify Meraki network configuration, or enable every polling input without reviewing rate and volume impact.

Examples

Run the diagnostic validator before account creation:

bash skills/cisco-meraki-ta-setup/scripts/validate.sh

Expected output: package, Splunk access, account prerequisites, and local tools are reported without changing the Meraki organization or Splunk inputs.

Run the completion gate after enabling selected inputs:

bash skills/cisco-meraki-ta-setup/scripts/validate.sh --completion

Expected output: account, enabled inputs, events, source types, macros, and dashboard evidence report [PASS] or exit nonzero.

Troubleshooting

TA Completion Gate

For every TA/add-on or dashboard companion run, satisfy the shared TA completion gate: configure and enable the data ingest path owned by this skill or its required companion, validate events or metrics in the target indexes/source types, and verify any pre-built/package-shipped dashboards are visible, macro-aligned, and returning data. If the package ships no dashboards, record that evidence explicitly and hand off dashboard use to the consuming app, ES/ITSI/ARI content, or readiness doctor.

Automates the Splunk Add-on for Cisco Meraki (Splunk_TA_cisco_meraki).

Package Model

Pull from Splunkbase first (latest version), fall back to splunk-ta/. Use splunk-app-install with --source splunkbase --app-id 5580 to get the latest release. If Splunkbase is unavailable, fall back to the local package in splunk-ta/. This applies to both Splunk Cloud (ACS) and Splunk Enterprise.

After installation, use this skill to configure the account, inputs, dashboard macro, and validation over search-tier REST. Any splunk-ta/_unpacked/ tree is review-only.

Agent Behavior — Credentials

The agent must NEVER ask for passwords, API keys, or secrets in chat.

Splunk credentials are read automatically from the project-root credentials file (falls back to ~/.splunk/credentials). If neither exists, guide the user to create it:

bash skills/shared/scripts/setup_credentials.sh

For the Meraki Dashboard API key, instruct the user to write it to a temporary file:

# User creates the file themselves (agent never sees the secret)
bash skills/shared/scripts/write_secret_file.sh /tmp/meraki_api_key

Then the agent passes --api-key-file /tmp/meraki_api_key to the configure script. After the account is created, delete the temp file.

The agent may freely ask for non-secret values: account names, org IDs, regions, etc.

For prerequisite collection, use skills/cisco-meraki-ta-setup/template.example as the intake worksheet. Copy it to template.local, fill in non-secret values there, and keep the completed file local only.

Environment

Setup and validation use the Splunk search-tier REST API and can run from any host with network access to the Splunk management port (8089). In Splunk Cloud, app installation, index creation, and restarts are handled through ACS instead of the search-tier REST endpoints.

Remote Splunk Connection

To run against a remote Splunk instance:

export SPLUNK_SEARCH_API_URI="https://splunk-host:8089"

Splunk Authentication

Scripts read Splunk credentials from the project-root credentials file. They fall back to ~/.splunk/credentials automatically. No environment variables or command-line password arguments are needed:

bash skills/cisco-meraki-ta-setup/scripts/validate.sh

If credentials are not yet configured, run the setup script first:

bash skills/shared/scripts/setup_credentials.sh

Setup Workflow

Step 1: Create Index and Configure Dashboards

bash skills/cisco-meraki-ta-setup/scripts/setup.sh

Creates the index, sets the meraki_index dashboard macro, and ensures the app is visible in Splunk Web. When run interactively (TTY), the script prompts to continue with account configuration after the initial setup completes. The app package provides its own dashboards; this step wires the macro and app visibility so those dashboards resolve against the right index.

No sudo required when running as the splunk user. In Splunk Cloud, the setup script creates the index through ACS.

Partial runs: --indexes-only (skips dashboard macro and visibility fix).

Step 2: Configure Organization Account

Before running, the agent must ask the user for non-secret values:

• Account name (e.g., "MY_ORG")
• Organization ID
• Region (global, india, canada, china, fedramp)
• Whether to auto-create inputs (recommended)

For the Meraki Dashboard API key, instruct the user to write it to a temp file and pass --api-key-file. The agent never sees the key.

Accounts are created via the Splunk REST API, which handles API key encryption automatically through the TA's custom REST handlers:

bash skills/cisco-meraki-ta-setup/scripts/configure_account.sh \
  --name "MY_ORG" \
  --api-key-file /tmp/meraki_api_key \
  --org-id "123456789" \
  --region global \
  --auto-inputs \
  --index meraki

Copy/paste secret-file prep command:

bash skills/shared/scripts/write_secret_file.sh /tmp/meraki_api_key

REST endpoint used (API key encryption handled automatically):

• /servicesNS/nobody/Splunk_TA_cisco_meraki/Splunk_TA_cisco_meraki_account

Account fields:

Step 3: Enable Inputs (if not using auto-create)

If --auto-inputs was used in Step 2, all inputs are created automatically. Otherwise, enable manually:

bash skills/cisco-meraki-ta-setup/scripts/setup.sh --enable-inputs \
  --account "MY_ORG" --index "meraki" --input-type all

webhook_logs is API polling and is included in all. The separate HEC-based webhook input still requires its own HEC configuration and is not created by this setup flow.

Step 4: Restart If Required

On Splunk Enterprise, restart Splunk after new index creation. On Splunk Cloud, check acs status current-stack and only run acs restart current-stack when ACS reports restartRequired=true.

Step 5: Validate

bash skills/cisco-meraki-ta-setup/scripts/validate.sh --completion

Checks: app installation, index, account, inputs, data flow, settings.

Dashboards

The app ships its dashboards in the package. They appear in Splunk Web automatically after installation — no import or manual activation is needed.

To access them: Apps → Splunk Add-on for Cisco Meraki

The meraki_index macro (set during Step 1) controls which index the dashboards query. If dashboards show no data after inputs are enabled and data is confirmed in the index, run:

bash skills/cisco-meraki-ta-setup/scripts/setup.sh

to re-apply the macro and visibility settings.

On Splunk Cloud, dashboards are available immediately after ACS completes the app install. Macro updates run over search-tier REST.

Sourcetypes

See reference.md for the full sourcetype catalog (35+).

MCP Server Integration

Load custom tools into the MCP Server. Credentials come from the project-root credentials file or the ~/.splunk/credentials fallback:

bash skills/cisco-meraki-ta-setup/scripts/load_mcp_tools.sh

Key Learnings / Known Issues

1. REST API for accounts: This TA uses custom REST handlers — always create accounts via the REST API, not by writing conf files manually. The handlers encrypt the API key automatically.
2. Auto-create inputs: Setting automatic_input_creation=1 creates all inputs at account creation time. This is the recommended approach.
3. Restart behavior differs by platform: Enterprise requires a Splunk restart after new index creation. Splunk Cloud uses ACS restart checks.
4. No sudo needed: Scripts run fine as the splunk OS user.
5. Region determines base URL: global→api.meraki.com, india→api.meraki.in, canada→api.meraki.ca, china→api.meraki.cn, fedramp→api.gov-meraki.com.
6. Webhook inputs split in two: webhook_logs is API polling and is included in the scripted all enablement path. The separate webhook input requires HEC configuration and is not created by this setup flow.
7. Rate limiting: The max_api_calls_per_second field controls API rate limiting (default 5, max 10).
8. ACS deployment verification: After ACS install, verify the app identity via REST (configs/conf-app/package). ACS can occasionally deploy the wrong app content into an app directory. If app.conf shows a different app ID, uninstall and reinstall the app individually.
9. Visibility after ACS install: The app may default to visible=false after ACS install, making it invisible in Splunk Web. The setup script now sets visible=true automatically. The standalone fix is a POST to /services/apps/local/Splunk_TA_cisco_meraki with visible=true.
10. Dashboard macro in default setup: The setup.sh default flow (no flags) now creates indexes AND configures the meraki_index dashboard macro. setup_dashboards.sh still exists for standalone use or custom index names.
11. Interactive continuation: When run from a TTY, setup.sh prompts to continue with account configuration after the initial setup completes. This is skipped in non-interactive (piped) contexts.

Additional Resources

• reference.md — Complete input catalog, account fields, sizing
• mcp_tools.json — MCP tool definitions

Validation Modes

Run scripts/validate.sh for diagnostics. Use --completion (alias --strict) to require an organization account, enabled input, Meraki events and sourcetypes, the meraki_index macro, and visible shipped dashboards.