Splunk Add-on for Microsoft Windows Setup
Prerequisites
| Tool or access | Purpose | Verify |
|---|---|---|
| Bash and Python 3 | Run bundled setup and validation helpers | bash --version && python3 --version |
| Required product/platform access | Inspect or configure the selected target | Complete the documented preflight |
| Credential files for live modes | Keep secrets out of chat | Verify paths only |
Workflow Overview
┌───────────┐ ┌───────────────┐ ┌───────────────┐ ┌─────────────────┐
│ Preflight │ → │ Render/review │ → │ Apply/handoff │ → │ Validate evidence │
└───────────┘ └───────────────┘ └───────────────┘ └─────────────────┘
When to Activate
- Splunk_TA_windows, the Splunk Add-on for Microsoft Windows, WinEventLog or Perfmon inputs, Windows Security event onboarding, Sysmon, or Windows CIM readiness in Splunk.
- Preview and review the splunk windows ta setup workflow before any live apply phase.
- Diagnose failed prerequisites, generated assets, configuration, or validation evidence.
Scope
Follow the documented read-only or render-first path whenever it is available. This skill does not imply permission to mutate live systems. Require explicit apply flags, protected credentials, and operator review for state changes.
Examples
Inspect the supported setup modes before selecting one:
bash skills/splunk-windows-ta-setup/scripts/setup.sh --help
Expected output: usage, supported modes, and required arguments are displayed without changing the target environment.
Inspect validation modes before running completion checks:
bash skills/splunk-windows-ta-setup/scripts/validate.sh --help
Expected output: offline, live, and completion options are displayed when the skill supports them; help exits without mutation.
Troubleshooting
| Issue | Cause | Resolution |
|---|---|---|
| Preflight fails | A required tool or access path is missing | Resolve it before rendering or applying |
| Rendered assets are incomplete | Required non-secret inputs are absent | Complete intake and render again |
| Apply is blocked | Review, credentials, or explicit acceptance is missing | Use the documented handoff |
| Validation is incomplete | Live evidence is unavailable | Record the gap and keep completion open |
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.
Render-first automation for the Splunk Add-on for Microsoft Windows
(Splunk_TA_windows, Splunkbase 742). The add-on collects Windows Event Log,
performance counters, and host-monitoring data. Inputs run on Windows
Universal Forwarders; parsing, knowledge objects, and CIM mappings run on the
search tier and indexers.
This skill renders reviewable inputs.conf/props.conf overlays, creates the
event and metrics indexes through the Splunk control plane, and hands the
Windows-side input rollout to splunk-agent-management-setup. It never edits a
Windows host directly.
Placement
| Role | Splunk_TA_windows |
|---|---|
| Universal Forwarder (Windows) | Required for inputs (WinEventLog, Perfmon, WinHostMon) |
| Heavy Forwarder | Supported when an HF collects/parses Windows data |
| Indexer | Supported for index-time parsing |
| Search tier | Required for search-time knowledge objects and CIM |
Enable inputs on Windows forwarders with local configuration files, not the Splunk Web setup page. Keep the add-on visible off on search heads.
Workflow
- Render reviewable assets (no Splunk credentials needed):
bash skills/splunk-windows-ta-setup/scripts/setup.sh --render \
--event-index wineventlog --perfmon-index perfmon
- Install the add-on on the search tier and create indexes:
bash skills/splunk-windows-ta-setup/scripts/setup.sh --install --create-index \
--event-index wineventlog --perfmon-index perfmon
- Roll the forwarder app out to Windows hosts through Agent Management:
bash skills/splunk-agent-management-setup/scripts/setup.sh \
--mode agent-manager --deployment-app-name Splunk_TA_windows
- Validate the deployment:
bash skills/splunk-windows-ta-setup/scripts/validate.sh
- Score post-ingest CIM/data readiness:
bash skills/splunk-data-source-readiness-doctor/scripts/setup.sh \
--phase collect --source-pack windows_security
Rendered Inputs
The renderer emits a starter inputs.local.conf overlay with WinEventLog
Security/System/Application (plus Defender and PowerShell operational
channels), Perfmon CPU / memory / network / disk counters, and WinHostMon
stanzas, each pinned to the chosen indexes. Sysmon is a separate add-on and is
listed as a handoff, not bundled here. Review channels, intervals, and counter
catalogs before enabling in production.
See reference.md for the full source-type catalog, CIM data-model mapping,
index model, and placement guardrails.