Skip to content

Agent_PowerShell_Scripts.md

Latest commit

 

History

History
68 lines (52 loc) · 3.9 KB

Agent_PowerShell_Scripts.md

File metadata and controls

68 lines (52 loc) · 3.9 KB

Zabbix Agent PowerShell Scripts: Ping & Web Monitoring

Overview

This project provides advanced monitoring for Zabbix using PowerShell scripts and Zabbix Agent 2. It includes:

  • Ping Checks: ICMP reachability and latency monitoring.
  • Web Checks: HTTP/HTTPS endpoint monitoring with status, latency, and content validation.

Project Evolution

  • Initial scripts provided basic checks and single-value outputs.
  • Refactored for robust parameter handling, error management, and JSON output.
  • All Zabbix UserParameter keys and YAML template item keys now use the custom. prefix for consistency.
  • YAML templates updated for LLD, macros, triggers, and tag inheritance.
  • Now supports both Zabbix Agent 2 and legacy Zabbix Agent (with minor adjustments).

Compatibility

  • Zabbix Agent 2: Fully supported. Uses UserParameter for direct PowerShell execution.
  • Zabbix Agent (legacy): Supported for basic checks, but advanced features (JSON output, LLD) require Agent 2.

Installation Instructions

1. Install Zabbix Agent 2

  • Download Zabbix Agent 2 from Zabbix Downloads.
  • Run installer and follow prompts.
  • Ensure service is running (zabbix_agent2.exe).

2. Deploy PowerShell Scripts

  • Copy all .ps1 scripts from this repository to: C:\Program Files\Zabbix Agent 2\Scripts
  • Ensure the Zabbix service user has read/execute permissions.

3. Configure Zabbix Agent 2

  • Edit zabbix_agentd.conf (or zabbix_agent2.conf) and add:
# Ping reachability (1 = success, 0 = fail)
UserParameter=custom.ping[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -File "C:\Program Files\Zabbix Agent 2\Scripts\agent_ping_check_bool.ps1" -Ip "$1" -Count "$2" -Timeout "$3" -BufferSize "$4" -TimeToLive "$5" -DontFragment "$6"

# Ping latency in milliseconds
UserParameter=custom.ping.latency[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -File "C:\Program Files\Zabbix Agent 2\Scripts\agent_ping_check.ps1" -Ip "$1" -Count "$2" -Timeout "$3" -BufferSize "$4" -TimeToLive "$5" -DontFragment "$6"

# Web availability (1/0)
UserParameter=custom.web.available[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -Command "& { $r = & 'C:\Program Files\Zabbix Agent 2\Scripts\agent_web_check.ps1' -Url '$1' -Timeout '$2' -ExpectCode '$3'; ($r | ConvertFrom-Json).available }"

# Web latency in milliseconds
UserParameter=custom.web.latency[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -Command "& { $r = & 'C:\Program Files\Zabbix Agent 2\Scripts\agent_web_check.ps1' -Url '$1' -Timeout '$2' -ExpectCode '$3'; ($r | ConvertFrom-Json).time_ms }"

# Web HTTP status code
UserParameter=custom.web.code[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -Command "& { $r = & 'C:\Program Files\Zabbix Agent 2\Scripts\agent_web_check.ps1' -Url '$1' -Timeout '$2' -ExpectCode '$3'; ($r | ConvertFrom-Json).status }"

# Web content match (1/0)
UserParameter=custom.web.content[*],powershell.exe -NoProfile -ExecutionPolicy Bypass -Command "& { $r = & 'C:\Program Files\Zabbix Agent 2\Scripts\agent_web_check.ps1' -Url '$1' -Timeout '$2' -ExpectCode '$3' -ExpectContent '$4'; ($r | ConvertFrom-Json).content_match }"

4. Import Templates

  • Import the agent_ping_check.yaml and agent_web_check.yaml templates into Zabbix.
  • Assign templates to target hosts.

Notes

  • For legacy Zabbix Agent, use only the basic ping and web checks (no JSON parsing).
  • Advanced features (LLD, content match, tags) require Zabbix Agent 2 and updated templates.
  • All PowerShell scripts use extensive error handling and structured output for reliability.
  • Scripts are designed to be lightweight and efficient for frequent monitoring intervals.

Troubleshooting

  • Verify PowerShell execution policy allows script execution
  • Check Zabbix Agent 2 service user permissions on script files
  • Test scripts manually via PowerShell before configuring in Zabbix
  • Review Zabbix Agent logs for execution errors