Zabbix

https://www.zabbix.com/documentation/current/en
Admin
Zabbix is an enterprise-class open-source monitoring solution for networks and applications.
Tokens:1,529,896
Snippets:11,149
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Package setup prompts

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/items/kerberos

Example answers for the Kerberos package configuration prompts.

```text
Default Kerberos version 5 realm: EXAMPLE.COM
Kerberos servers for your realm: localhost (or your FQDN)
Administrative server for your Kerberos realm: localhost (or your FQDN)
```

--------------------------------

### Install Zabbix Go SDK with specific commit

Source: https://www.zabbix.com/documentation/current/en/devel/plugins/how_to

Example of installing the Zabbix Go SDK with a specific commit hash. Note that golang.zabbix.com/sdk versioning is currently not supported.

```bash
go get golang.zabbix.com/sdk@af85407
```

--------------------------------

### Elasticsearch GET request example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/http

Example of sending a GET request to Elasticsearch and the resulting JSON response.

```json
    {
      "name" : "YQ2VAY-",
      "cluster_name" : "elasticsearch",
      "cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
      "version" : {
        "number" : "6.1.3",
        "build_hash" : "af51318",
        "build_date" : "2018-01-26T18:22:55.523Z",
        "build_snapshot" : false,
        "lucene_version" : "7.1.0",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You know, for search"
    }
```

--------------------------------

### system.run[ls -l /] example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.run item key with the command 'ls -l /', returning a detailed file list of the root directory.

```text
system.run[ls -l /] #return a detailed file list of the root directory
```

--------------------------------

### Install and start NetworkManager for static IP

Source: https://www.zabbix.com/documentation/current/en/manual/appliance

Install NetworkManager, enable it at boot, and start it to configure a static IP address. Run as root.

```bash
dnf install NetworkManager
systemctl enable NetworkManager
systemctl start NetworkManager
```

--------------------------------

### Start Zabbix agent manually with launchctl

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install_from_packages/mac_pkg

Start the Zabbix agent manually using launchctl. The agent normally starts automatically after installation or restart.

```bash
sudo launchctl start com.zabbix.zabbix_agentd
```

--------------------------------

### Show configure help

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install

Displays all supported configuration options for the Zabbix source.

```bash
./configure --help
```

--------------------------------

### system.hw.chassis[full] example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.hw.chassis item key with the full parameter, showing the returned chassis information string.

```text
system.hw.chassis[full] → Hewlett-Packard HP Pro 3010 Small Form Factor PC CZXXXXXXXX Desktop
```

--------------------------------

### mid() example

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/functions/string

Returns a substring of N characters beginning at the character position specified by 'start'. Supported value types: String, Text, Log. Parameters: value, start, length. For example, it is possible to return 'abbi' from a value like 'Zabbix' if starting position is 2 and positions to return is 4.

```plaintext
mid(last(/host/key),2,4)="abbi"
```

--------------------------------

### onResize() method example

Source: https://www.zabbix.com/documentation/current/en/devel/modules/widgets/presentation

Adjusts widget visual elements when resized. The example checks if the widget is active and starts updating.

```javascript
onResize() {
    if (this.getState() === WIDGET_STATE_ACTIVE) {
        this._startUpdating();
    }
}
```

--------------------------------

### settings.get request example

Source: https://www.zabbix.com/documentation/current/en/manual/api/reference/settings/get

Example request to retrieve settings with output extended.

```json
{
    "jsonrpc": "2.0",
    "method": "settings.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}
```

--------------------------------

### system.cpu.load item key example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.cpu.load item key with the avg5 mode to get the five-minute average load.

```plaintext
system.cpu.load[,avg5]
```

--------------------------------

### Example /etc/krb5.conf settings

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/items/kerberos

Example Kerberos configuration with realm, KDC, and domain mapping. Mismatches can cause 'Server not found in Kerberos database' errors.

```ini
[libdefaults]
    default_realm = EXAMPLE.COM
    dns_lookup_realm = false
    dns_lookup_kdc = false
    rdns = false
    ticket_lifetime = 24h
    renew_lifetime = 7d
    forwardable = true

[realms]
    EXAMPLE.COM = {
        kdc = dc01.example.com
        admin_server = dc01.example.com
    }

[domain_realm]
    .example.com = EXAMPLE.COM
    example.com = EXAMPLE.COM
```

--------------------------------

### Download and install custom MIB file (CISCO-SMI)

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/snmp/mibs

Commands to download and install a custom MIB file, using CISCO-SMI as an example.

```bash
wget ftp://ftp.cisco.com/pub/mibs/v2/CISCO-SMI.my -P /tmp
mkdir -p /usr/local/share/snmp/mibs
grep -q '^mibdirs +/usr/local/share/snmp/mibs' /etc/snmp/snmp.conf 2>/dev/null || echo "mibdirs +/usr/local/share/snmp/mibs" >> /etc/snmp/snmp.conf
cp /tmp/CISCO-SMI.my /usr/local/share/snmp/mibs
```

--------------------------------

### Initialize vcpkg and install dependencies for Zabbix agent 2

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/building_zabbix_agent_2_on_windows

Run these commands in a command prompt to initialize vcpkg and install required ports (pcre2, libiconv, openssl). The commands set the PATH for vcpkg and then for MinGW (64-bit or 32-bit) before installing with the appropriate triplet. Note that installation may take some time.

```batch
cd C:\Zabbix

set PATH=%PATH%;"C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\vcpkg"
vcpkg new --application
vcpkg add port pcre2
vcpkg add port libiconv
vcpkg add port openssl

# For 64-bit builds:
set PATH=C:\Zabbix\mingw64\bin;%PATH%
vcpkg install --triplet x64-mingw-static --x-install-root=x64

# For 32-bit builds:
set PATH=C:\Zabbix\mingw32\bin;%PATH%
vcpkg install --triplet x86-mingw-static --x-install-root=x86
```

--------------------------------

### Zabbix agent 2 command-line parameter examples

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/agent2

Examples of using Zabbix agent 2 command-line parameters: print all built-in items, test a user parameter with the mysql.ping key, install the Windows service, and modify the startup type of an installed Windows service.

```bash
zabbix_agent2 --print
zabbix_agent2 -t "mysql.ping" -c /etc/zabbix/zabbix_agentd.conf
zabbix_agent2.exe -i
zabbix_agent2.exe -c zabbix_agent2.conf -S delayed
```

--------------------------------

### Zabbix agent command-line parameter examples

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/agent

Examples of using Zabbix agent command-line parameters: printing built-in items, testing a user parameter with the mysql.ping key, installing the Windows service, installing a uniquely named service with -m, and setting the startup type to delayed.

```bash
zabbix_agentd --print
zabbix_agentd -t "mysql.ping" -c /etc/zabbix/zabbix_agentd.conf
zabbix_agentd.exe -i
zabbix_agentd.exe -i -m -c zabbix_agentd.conf
zabbix_agentd.exe -c zabbix_agentd.conf -S delayed
```

--------------------------------

### Initialize vcpkg and install dependencies

Source: https://www.zabbix.com/documentation/current/en/manual/installation/install/win_agent

Initialize vcpkg and install the PCRE2 and OpenSSL dependencies for building Zabbix agent. Run from an administrator command prompt in the C:\Zabbix working directory; installation may take some time.

```batch
cd C:\Zabbix
vcpkg new --application
vcpkg add port pcre2
vcpkg add port openssl
vcpkg install --triplet x64-windows-static --x-install-root="C:\Program Files\Zabbix\x64"
```

--------------------------------

### Start Zabbix server with init script

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/server

Alternative start command for systems without systemd, using the init script.

```bash
/etc/init.d/zabbix-server start
```

--------------------------------

### Start Java application with minimal JMX options

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/jmx_monitoring

Starts a Java application with remote JMX monitoring enabled on port 12345, listening on localhost only, with authentication and SSL disabled. This is the bare minimum to get started.

```bash
java \
-Dcom.sun.management.jmxremote \
-Dcom.sun.management.jmxremote.port=12345 \
-Dcom.sun.management.jmxremote.authenticate=false \
-Dcom.sun.management.jmxremote.ssl=false \
-Dcom.sun.management.jmxremote.registry.ssl=false \
-jar /path/to/your/application.jar
```

--------------------------------

### Example odbcinst.ini for MySQL driver

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/odbc_checks

Example configuration for the odbcinst.ini file, listing the installed ODBC database drivers. If the file is missing, it must be created manually.

```ini
[TEST_MYSQL]
Description=ODBC for MySQL
Driver=/usr/lib/libmyodbc5.so
FileUsage=1
```

--------------------------------

### settings.get response example

Source: https://www.zabbix.com/documentation/current/en/manual/api/reference/settings/get

Example response containing the settings object with all settings fields.

```json
{
    "jsonrpc": "2.0",
    "result": {
        "default_theme": "blue-theme",
        "search_limit": "1000",
        "max_in_table": "50",
        "server_check_interval": "10",
        "work_period": "1-5,09:00-18:00",
        "show_technical_errors": "0",
        "history_period": "24h",
        "period_default": "1h",
        "max_period": "2y",
        "severity_color_0": "97AAB3",
        "severity_color_1": "7499FF",
        "severity_color_2": "FFC859",
        "severity_color_3": "FFA059",
        "severity_color_4": "E97659",
        "severity_color_5": "E45959",
        "severity_name_0": "Not classified",
        "severity_name_1": "Information",
        "severity_name_2": "Warning",
        "severity_name_3": "Average",
        "severity_name_4": "High",
        "severity_name_5": "Disaster",
        "custom_color": "0",
        "ok_period": "5m",
        "blink_period": "2m",
        "problem_unack_color": "CC0000",
        "problem_ack_color": "CC0000",
        "ok_unack_color": "009900",
        "ok_ack_color": "009900",
        "problem_unack_style": "1",
        "problem_ack_style": "1",
        "ok_unack_style": "1",
        "ok_ack_style": "1",
        "discovery_groupid": "5",
        "default_inventory_mode": "-1",
        "alert_usrgrpid": "7",
        "snmptrap_logging": "1",
        "default_lang": "en_US",
        "default_timezone": "system",
        "login_attempts": "5",
        "login_block": "30s",
        "validate_uri_schemes": "1",
        "uri_valid_schemes": "http,https,ftp,file,mailto,tel,ssh",
        "x_frame_options": "SAMEORIGIN",
        "iframe_sandboxing_enabled": "1",
        "iframe_sandboxing_exceptions": "",
        "max_overview_table_size": "50",
        "connect_timeout": "3s",
        "socket_timeout": "3s",
        "media_type_test_timeout": "65s",
        "script_timeout": "60s",
        "item_test_timeout": "60s",
        "url": "",
        "report_test_timeout": "60s",
        "auditlog_enabled": "1",
        "auditlog_mode": "1",
        "ha_failover_delay": "1m",
        "geomaps_tile_provider": "OpenStreetMap.Mapnik",
        "geomaps_tile_url": "",
        "geomaps_max_zoom": "0",
        "geomaps_attribution": "",
        "vault_provider": "0",
        "timeout_zabbix_agent": "3s",
        "timeout_simple_check": "3s",
        "timeout_snmp_agent": "3s",
        "timeout_external_check": "3s",
        "timeout_db_monitor": "3s",
        "timeout_http_agent": "3s",
        "timeout_ssh_agent": "3s",
        "timeout_telnet_agent": "3s",
        "timeout_script": "3s"
    },
    "id": 1
}
```

--------------------------------

### Run Zabbix proxy with command-line parameters

Source: https://www.zabbix.com/documentation/current/en/manual/concepts/proxy

Examples of running zabbix_proxy with a configuration file, help, and version flags.

```bash
zabbix_proxy -c /usr/local/etc/zabbix_proxy.conf
zabbix_proxy --help
zabbix_proxy -V
```

--------------------------------

### Install MSSQL unixODBC driver

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/odbc_checks

Install the MSSQL unixODBC database driver using the package manager for Ubuntu/Debian, RedHat/Fedora, or SUSE systems. For RedHat/Fedora, EPEL packages are required. For manual installation, refer to the FreeTDS user guide.

```bash
# For Ubuntu/Debian systems:
apt install tdsodbc

# For RedHat/Fedora-based systems (EPEL packages: https://docs.fedoraproject.org/en-US/epel/):
dnf install epel-release
dnf install freetds

# For SUSE-based systems:
zypper install libtdsodbc0
```

--------------------------------

### system.hw.cpu[0,vendor] example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.hw.cpu item key with cpu number 0 and vendor info, returning the CPU vendor string.

```text
system.hw.cpu[0,vendor] → AuthenticAMD
```

--------------------------------

### Start Zabbix web service

Source: https://www.zabbix.com/documentation/current/en/manual/appendix/install/web_service

Run the Zabbix web service process on the machine where it is installed. This command starts the web service, which is required for generating scheduled reports.

```bash
zabbix_web_service
```

--------------------------------

### system.swap.in example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.swap.in item key with the pages type parameter. The device parameter is left empty to use the default 'all'.

```text
system.swap.in[,pages]
```

--------------------------------

### vmware.datastore.hv.list output example

Source: https://www.zabbix.com/documentation/current/en/manual/vm_monitoring/vmware_keys

Shows example output from the vmware.datastore.hv.list item key, listing hypervisor hostnames.

```plaintext
esx7-01-host.zabbix.sandbox
esx7-02-host.zabbix.sandbox
```

--------------------------------

### system.uname examples

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Examples of the system.uname item key showing output on FreeBSD and Windows systems. The item returns the OS architecture on Windows and the CPU architecture on UNIX.

```text
system.uname → FreeBSD localhost 4.2-RELEASE FreeBSD 4.2-RELEASE #0: Mon Nov i386
```

```text
system.uname → Windows ZABBIX-WIN 6.0.6001 Microsoft® Windows Server® 2008 Standard Service Pack 1 x86
```

--------------------------------

### system.cpu.util item key example

Source: https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/zabbix_agent

Example of the system.cpu.util item key with CPU 0, user type, and avg5 mode to get the five-minute average user CPU utilization.

```plaintext
system.cpu.util[0,user,avg5]
```
Tokens:
Raw