Citrix Netscaler SDX
Plugin: go.d.plugin Module: snmp
Overview
Monitor Citrix Netscaler SDX (loadbalancer) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 1 device identifiers) and collects the metrics this profile declares — on top of the generic SNMP baseline — with no manual OID configuration.
Netdata's SNMP collector matches the device to the citrix-netscaler-sdx.yaml profile via sysObjectID/sysDescr, then polls the OIDs it declares.
This integration is supported on all platforms.
This integration supports multiple instances configured side-by-side.
Default Behavior
Auto-Detection
Auto-detected as Citrix Netscaler SDX via sysObjectID/sysDescr.
Limits
The default configuration for this integration does not impose any limits.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
You can configure the snmp collector in two ways:
| Method | Best for | How to |
|---|---|---|
| UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job. |
| File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/snmp.conf and add a job. |
UI configuration requires paid Netdata Cloud plan.
Prerequisites
SNMP access
SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.
Configuration
Options
Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.
via UI
Configure the snmp collector from the Netdata web interface:
- Go to Nodes.
- Select the node where you want the snmp data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
- The Collectors → Jobs view opens by default.
- In the Search box, type snmp (or scroll the list) to locate the snmp collector.
- Click the + next to the snmp collector to add a new job.
- Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
via File
The configuration file name for this integration is go.d/snmp.conf.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/snmp.conf
Examples
There are no configuration examples.
Alerts
There are no alerts configured by default for this integration.
Metrics
On top of the generic SNMP baseline (the Generic SNMP Device integration — interfaces, system, IP/TCP/UDP, host resources), this Citrix Netscaler SDX profile adds the metrics below. Each is collected only where the device exposes the matching OID — inclusion means the profile requests it; availability depends on the device model and software.
20 metrics in 8 groups; each row is a chart context usable in alerts.
| Group | Metrics |
|---|---|
| Hardware / Resource | 1 |
| Network / Interface | 7 |
| Storage / Repository | 3 |
| System / CPU | 1 |
| System / Memory | 1 |
| System / Software | 1 |
| System / Uptime | 1 |
| Virtualization / VirtualInstance | 5 |
Hardware / Resource
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_netscaler_sdx_hardwareResourceStatus | {status} | per netscaler_sdx_hardware_resource_name | Health status of the resource |
Network / Interface
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_netscaler_sdx_interfaceRxBytes | bit/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Received bytes |
snmp.device_prof_netscaler_sdx_interfaceRxErrors | {error}/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Receiving errors |
snmp.device_prof_netscaler_sdx_interfaceRxPackets | {packet}/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Received packets |
snmp.device_prof_netscaler_sdx_interfaceState | {status} | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | State of the Interface |
snmp.device_prof_netscaler_sdx_interfaceTxBytes | bit/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Transmitted bytes |
snmp.device_prof_netscaler_sdx_interfaceTxErrors | {error}/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Transmission errors |
snmp.device_prof_netscaler_sdx_interfaceTxPackets | {packet}/s | per netscaler_sdx_interface_port, netscaler_sdx_interface_mapped_port | Transmitted packets |
Storage / Repository
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_netscaler_sdx_srSize | By | per netscaler_sdx_sr_name, netscaler_sdx_sr_bay_number | Physical size of the storage repository |
snmp.device_prof_netscaler_sdx_srStatus | {status} | per netscaler_sdx_sr_name, netscaler_sdx_sr_bay_number | Status of the storage repository |
snmp.device_prof_netscaler_sdx_srUtilized | By | per netscaler_sdx_sr_name, netscaler_sdx_sr_bay_number | Physical utilization of the storage repository |
System / CPU
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_cpu_usage | % | per netscaler_sdx_xen_ip_address_type, netscaler_sdx_xen_ip_address, netscaler_sdx_xen_uuid | The current CPU utilization |
System / Memory
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_memory_usage | % | per netscaler_sdx_xen_ip_address_type, netscaler_sdx_xen_ip_address, netscaler_sdx_xen_uuid | Memory usage percentage of host |
System / Software
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_netscaler_sdx_softwareResourceStatus | {status} | per netscaler_sdx_software_resource_name | Health status of the resource |
System / Uptime
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_systemUptime | s | device | Time since the system was last rebooted or powered on. |
Virtualization / VirtualInstance
| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
snmp.device_prof_netscaler_sdx_nsHttpReq | {request}/s | per netscaler_sdx_ns_uuid, netscaler_sdx_ns_name | Http requests per second |
snmp.device_prof_netscaler_sdx_nsNsCPUUsage | % | per netscaler_sdx_ns_uuid, netscaler_sdx_ns_name | Cpu usage percentage of netscaler instance |
snmp.device_prof_netscaler_sdx_nsNsMemoryUsage | % | per netscaler_sdx_ns_uuid, netscaler_sdx_ns_name | Memory usage percentage |
snmp.device_prof_netscaler_sdx_nsNsRx | bit/s | per netscaler_sdx_ns_uuid, netscaler_sdx_ns_name | In throughput of netscaler instance in megabits per second |
snmp.device_prof_netscaler_sdx_nsNsTx | bit/s | per netscaler_sdx_ns_uuid, netscaler_sdx_ns_name | Out throughput of netscaler instance in megabits per second |
Troubleshooting
Other Problems
Collect Diagnostics for Netdata Support
For SNMP metrics, BGP, licensing, or topology issues, follow Collect SNMP troubleshooting data to include built-in diagnostics in a support bundle. SNMP evidence is unsanitized; share the bundle through a restricted Netdata Support ticket.
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.