Zabbix 7.0

https://www.zabbix.com/documentation/7.0/en
Admin
Zabbix is an open-source enterprise-class monitoring solution for networks, servers, applications,...
Tokens:1,569,352
Snippets:10,690
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Package setup prompts

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

Example responses to the package setup prompts for realm and server names. Use your own FQDN or localhost as appropriate.

```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)
```

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

### Deploy default Zabbix setup with Docker Compose

Source: https://www.zabbix.com/documentation/7.0/en/manual/installation/containers

Starts the default Zabbix setup (server, web interface on Nginx, and database) using either MySQL or PostgreSQL. The command uses the appropriate Compose file for the chosen database backend.

```bash
# With MySQL as the database:
docker compose -f ./compose.yaml up -d

# With PostgreSQL as the database:
docker compose -f ./compose_pgsql.yaml up -d
```

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

### Create and set up handler in run()

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

Registers the 'myip' item key, creates a handler, sets up logging, and starts plugin execution.

```go
func run() error {
    p := &myIP{}

    // Register the `myip` item key.
    err := plugin.RegisterMetrics(
        p,
        "MyIP",                           // Plugin name
        "myip",                           // Item key name
        "Returns the host's IP address.", // Item key description
    )
    if err != nil {
        return errs.Wrap(err, "failed to register metrics")
    }

    // Create a new handler.
    h, err := container.NewHandler("MyIP") // Plugin name
    if err != nil {
        return errs.Wrap(err, "failed to create new handler")
    }

    // Setup logging to forward logs from the plugin to the agent.
    // Available via p.Logger.Infof, p.Logger.Debugf, etc.
    p.Logger = h

    // Start plugin execution.
    // Blocks until a termination request is received from the agent.
    err = h.Execute()
    if err != nil {
        return errs.Wrap(err, "failed to execute plugin handler")
    }

    return nil
}
```

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

### Start Zabbix agent manually with launchctl

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

Starts the Zabbix agent service manually after installation or restart.

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

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

### Start Zabbix server with systemctl

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

Starts the Zabbix server daemon on most GNU/Linux systems when installed as a package.

```bash
systemctl start zabbix-server
```

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

### Install Zabbix Go SDK with specific commit

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

Example of installing the SDK with a specific commit hash (af85407).

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

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

### service.info examples

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

Shows how to query service state, display name, and startup type using the service.info key. The first two examples return the same state for the same service (by name and display name).

```plaintext
service.info[SNMPTRAP] - state of the SNMPTRAP service;
service.info[SNMP Trap] - state of the same service, but with the display name specified;
service.info[EventLog,startup] - the startup type of the EventLog service
```

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

### Run zabbix_web_service

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

Starts the Zabbix web service process after installation. Run on the machine where the web service is installed.

```bash
zabbix_web_service
```

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

### Initialize vcpkg and install dependencies

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

Run these commands in cmd.exe with administrator privileges to initialize vcpkg and install PCRE2 and OpenSSL for the x64-windows-static triplet. The 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"
```

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

### mid() example

Source: https://www.zabbix.com/documentation/7.0/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 - the value to check; start - start position; length - positions to return. Example: mid(last(/host/key),2,4)="abbi".

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

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

### Start Zabbix server with init.d script

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

Alternative start command for systems where systemctl is not available.

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

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

### Start Zabbix proxy with init script

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

Alternative startup command for systems that do not use systemctl.

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

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

### Zabbix agent command-line parameter examples

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

Examples of using Zabbix agent command-line parameters: printing built-in items, testing a user parameter, installing the Windows service, installing with multiple agents, and modifying the startup type.

```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
```

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

### Show configure help

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

Lists all supported configuration options for the Zabbix source.

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

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

### Start Zabbix agent 2 service

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

Starts the Zabbix agent 2 service on Unix-like systems when installed as a package.

```bash
systemctl start zabbix-agent2
```

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

### wmi.get example

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

Shows how to execute a WMI query that returns the first selected object. The example queries the status of the first physical disk.

```plaintext
wmi.get[root\cimv2,select status from Win32_DiskDrive where Name like '%PHYSICALDRIVE0%'] #returns the status of the first physical disk
```

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

### onResize() method example

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

Example implementation of the onResize() method, which is invoked when the widget is resized. It 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/7.0/en/manual/api/reference/settings/get

Example request to retrieve all settings using the output parameter set to 'extend'.

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

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

### Zabbix agent 2 command-line usage examples

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

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

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

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

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

Runs a command on the host. The example shows the 'wait' mode (default) returning the command output. The item is disabled by default and requires enabling.

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

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

### vfs.dir.get examples

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

Two examples of using vfs.dir.get: one to retrieve the device list in /dev on Linux, and another to retrieve the file list in a temporary directory on Windows.

```plaintext
vfs.dir.get[/dev] #retrieves the device list in /dev (Linux)
vfs.dir.get["C:\Users\ADMINI~1\AppData\Local\Temp"] #retrieves the file list in a temporary directory
```

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

### odbcinst.ini example for MySQL driver

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

Example entry for the odbcinst.ini file that lists installed ODBC drivers. The Driver parameter points to the driver library.

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

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

### Open kadmin.local

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

Start the Kerberos administration shell to create principals and keytabs.

```bash
sudo kadmin.local
```

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

### Install KDC and client utilities

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

Install Kerberos KDC, admin server, and user utilities on Debian/Ubuntu. During package setup, you will be prompted for realm and server details.

```bash
sudo apt update
sudo apt install krb5-kdc krb5-admin-server krb5-user
```

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

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

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

Returns chassis information. The example shows the default 'full' parameter producing a string with vendor and model. Requires root permissions and depends on SMBIOS table availability.

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

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

### Install Zabbix agent 2 plugins via msiexec command line

Source: https://www.zabbix.com/documentation/7.0/en/manual/installation/install_from_packages/win_msi

Command-line installation of Zabbix agent 2 loadable plugins using msiexec. The example logs installation to a file and runs silently with /qn+.

```bash
msiexec.exe /l*v "C:\package.log" /i "C:\zabbix_agent2_plugins-7.0.0-windows-amd64.msi" /qn+
```

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

### system.swap.size[,pfree] example

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

Example of the system.swap.size item key with the pfree type to get free swap space percentage. The device parameter is left empty to use the default 'all'.

```plaintext
system.swap.size[,pfree] → free swap space percentage
```

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

### settings.get response example

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

Example response containing the settings object with all settings values.

```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
}
```

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

### Install Zabbix Go SDK dependency

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

Install the mandatory Zabbix Go SDK dependency using `go get`. Replace `$LATEST_COMMIT_HASH` with the latest HEAD commit hash from the repository.

```bash
go get golang.zabbix.com/sdk@$LATEST_COMMIT_HASH
```

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

### wmi.getall example

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

Shows how to execute a WMI query that returns the whole response as a JSON object, useful for low-level discovery. The example retrieves status information of physical disks.

```plaintext
wmi.getall[root\cimv2,select * from Win32_DiskDrive where Name like '%PHYSICALDRIVE%'] #returns status information of physical disks
```

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

### vm.vmemory.size example

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

Shows how to get available virtual memory as a percentage using the pavailable type.

```plaintext
vm.vmemory.size[pavailable] #return the available virtual memory, in percentage
```
Tokens:
Raw