table of contents
ZABBIX_SENDER(1) | General Commands Manual | ZABBIX_SENDER(1) |
NAME¶
zabbix_sender - Zabbix sender utility
SYNOPSIS¶
zabbix_sender [-v] -z server
[-p port] [-I IP-address] [-t
timeout] -s host -k key -o
value
zabbix_sender [-v] -z server [-p
port] [-I IP-address] [-t timeout]
[-s host] [-T] [-N] [-r] -i
input-file
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] -k key
-o value
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] [-T] [-N]
[-r] -i input-file
zabbix_sender [-v] -z server [-p
port] [-I IP-address] [-t timeout]
-s host --tls-connect cert --tls-ca-file
CA-file [--tls-crl-file CRL-file]
[--tls-server-cert-issuer cert-issuer]
[--tls-server-cert-subject cert-subject]
--tls-cert-file cert-file --tls-key-file
key-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] -k key -o
value
zabbix_sender [-v] -z server [-p
port] [-I IP-address] [-t timeout]
[-s host] --tls-connect cert
--tls-ca-file CA-file [--tls-crl-file CRL-file]
[--tls-server-cert-issuer cert-issuer]
[--tls-server-cert-subject cert-subject]
--tls-cert-file cert-file --tls-key-file
key-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] [-T] [-N]
[-r] -i input-file
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] --tls-connect
cert --tls-ca-file CA-file [--tls-crl-file
CRL-file] [--tls-server-cert-issuer cert-issuer]
[--tls-server-cert-subject cert-subject]
--tls-cert-file cert-file --tls-key-file
key-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] -k key -o
value
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] --tls-connect
cert --tls-ca-file CA-file [--tls-crl-file
CRL-file] [--tls-server-cert-issuer cert-issuer]
[--tls-server-cert-subject cert-subject]
--tls-cert-file cert-file --tls-key-file
key-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] [-T] [-N]
[-r] -i input-file
zabbix_sender [-v] -z server [-p
port] [-I IP-address] [-t timeout]
-s host --tls-connect psk
--tls-psk-identity PSK-identity --tls-psk-file
PSK-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] -k key -o
value
zabbix_sender [-v] -z server [-p
port] [-I IP-address] [-t timeout]
[-s host] --tls-connect psk
--tls-psk-identity PSK-identity --tls-psk-file
PSK-file [--tls-cipher13 cipher-string]
[--tls-cipher cipher-string] [-T] [-N]
[-r] -i input-file
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] --tls-connect
psk --tls-psk-identity PSK-identity
--tls-psk-file PSK-file [--tls-cipher13
cipher-string] [--tls-cipher cipher-string] -k
key -o value
zabbix_sender [-v] -c config-file [-z
server] [-p port] [-I IP-address]
[-t timeout] [-s host] --tls-connect
psk --tls-psk-identity PSK-identity
--tls-psk-file PSK-file [--tls-cipher13
cipher-string] [--tls-cipher cipher-string] [-T]
[-N] [-r] -i input-file
zabbix_sender -h
zabbix_sender -V
DESCRIPTION¶
zabbix_sender is a command line utility for sending monitoring data to Zabbix server or proxy. On the Zabbix server an item of type Zabbix trapper should be created with corresponding key. Note that incoming values will only be accepted from hosts specified in Allowed hosts field for this item.
OPTIONS¶
- -c, --config config-file
- Use config-file. Zabbix sender reads server details from the agentd configuration file. By default Zabbix sender does not read any configuration file. Only parameters Hostname, ServerActive, SourceIP, TLSConnect, TLSCAFile, TLSCRLFile, TLSServerCertIssuer, TLSServerCertSubject, TLSCertFile, TLSKeyFile, TLSPSKIdentity and TLSPSKFile are supported. Hostname defined through HostnameItem parameter will not be picked up, in this case the hostname should be specified via command line (see -s option). All addresses defined in the agent ServerActive configuration parameter are used for sending data. If sending of batch data fails to one address, the following batches are not sent to this address.
- -z, --zabbix-server server
- Hostname or IP address of Zabbix server. If a host is monitored by a proxy, proxy hostname or IP address should be used instead. When used together with --config, overrides the entries of ServerActive parameter specified in agentd configuration file.
- -p, --port port
- Specify port number of Zabbix server trapper running on the server. Default is 10051. When used together with --config, overrides the port entries of ServerActive parameter specified in agentd configuration file.
- -I, --source-address IP-address
- Specify source IP address. When used together with --config, overrides SourceIP parameter specified in agentd configuration file.
- -t, --timeout seconds
- Specify timeout. Valid range: 1-300 seconds (default: 60)
- -s, --host host
- Specify host name the item belongs to (as registered in Zabbix frontend). Host IP address and DNS name will not work. When used together with --config, overrides Hostname parameter specified in agentd configuration file.
- -k, --key key
- Specify item key to send value to.
- -o, --value value
- Specify item value.
- -i, --input-file input-file
- Load values from input file. Specify - as <input-file>
to read values from standard input. Each line of file contains whitespace
delimited: <hostname> <key> <value>. Each value
must be specified on its own line. Each line must contain 3 whitespace
delimited entries: <hostname> <key> <value>,
where "hostname" is the name of monitored host as registered in
Zabbix frontend, "key" is target item key and "value"
- the value to send. Specify - as <hostname> to use
hostname from agent configuration file or from --host argument.
An example of a line of an input file:
"Linux DB3" db.connections 43
The value type must be correctly set in item configuration of Zabbix frontend. Zabbix sender will send up to 250 values in one connection. Contents of the input file must be in the UTF-8 encoding. All values from the input file are sent in a sequential order top-down. Entries must be formatted using the following rules:
- •
- Quoted and non-quoted entries are supported.
- •
- Double-quote is the quoting character.
- •
- Entries with whitespace must be quoted.
- •
- Double-quote and backslash characters inside quoted entry must be escaped with a backslash.
- •
- Escaping is not supported in non-quoted entries.
- •
- Linefeed escape sequences (\n) are supported in quoted strings.
- •
- Linefeed escape sequences are trimmed from the end of an entry.
- -T, --with-timestamps
- This option can be only used with --input-file option.
Each line of the input file must contain 4 whitespace delimited entries: <hostname> <key> <timestamp> <value>. Timestamp should be specified in Unix timestamp format. If target item has triggers referencing it, all timestamps must be in an increasing order, otherwise event calculation will not be correct.
An example of a line of the input file:
"Linux DB3" db.connections 1429533600 43
For more details please see option --input-file.
If a timestamped value is sent for a host that is in a “no data” maintenance type then this value will be dropped; however, it is possible to send a timestamped value in for an expired maintenance period and it will be accepted.
- -N, --with-ns
- This option can be only used with --with-timestamps option.
Each line of the input file must contain 5 whitespace delimited entries: <hostname> <key> <timestamp> <ns> <value>.
An example of a line of the input file:
"Linux DB3" db.connections 1429533600 7402561 43
For more details please see option --input-file.
- -r, --real-time
- Send values one by one as soon as they are received. This can be used when reading from standard input.
- --tls-connect value
- How to connect to server or proxy. Values:
- unencrypted
- connect without encryption (default)
- psk
- connect using TLS and a pre-shared key
- cert
- connect using TLS and a certificate
- --tls-ca-file CA-file
- Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification.
- --tls-crl-file CRL-file
- Full pathname of a file containing revoked certificates.
- --tls-server-cert-issuer cert-issuer
- Allowed server certificate issuer.
- --tls-server-cert-subject cert-subject
- Allowed server certificate subject.
- --tls-cert-file cert-file
- Full pathname of a file containing the certificate or certificate chain.
- --tls-key-file key-file
- Full pathname of a file containing the private key.
- --tls-psk-identity PSK-identity
- PSK-identity string.
- --tls-psk-file PSK-file
- Full pathname of a file containing the pre-shared key.
- --tls-cipher13 cipher-string
- Cipher string for OpenSSL 1.1.1 or newer for TLS 1.3. Override the default ciphersuite selection criteria. This option is not available if OpenSSL version is less than 1.1.1.
- --tls-cipher cipher-string
- GnuTLS priority string (for TLS 1.2 and up) or OpenSSL cipher string (only for TLS 1.2). Override the default ciphersuite selection criteria.
- -v, --verbose
- Verbose mode, -vv for more details.
- -h, --help
- Display this help and exit.
- -V, --version
- Output version information and exit.
EXIT STATUS¶
The exit status is 0 if the values were sent and all of them were successfully processed by server. If data was sent, but processing of at least one of the values failed, the exit status is 2. If data sending failed, the exit status is 1.
EXAMPLES¶
zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k
mysql.queries -o 342.45
zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -s
"Monitored Host" -k mysql.queries -o 342.45
zabbix_sender -z 192.168.1.113 -i data_values.txt
Send values from file data_values.txt to Zabbix server with IP 192.168.1.113. Host names and keys are defined in the file.
echo "- hw.serial.number 1287872261 SQ4321ASDF" |
zabbix_sender -c /usr/local/etc/zabbix_agentd.conf -T -i -
echo '"Zabbix server" trapper.item ""' |
zabbix_sender -z 192.168.1.113 -p 10000 -i -
zabbix_sender -z 192.168.1.113 -s "Monitored Host" -k
mysql.queries -o 342.45 --tls-connect cert --tls-ca-file
/home/zabbix/zabbix_ca_file --tls-cert-file /home/zabbix/zabbix_agentd.crt
--tls-key-file /home/zabbix/zabbix_agentd.key
zabbix_sender -z 192.168.1.113 -s "Monitored Host" -k
mysql.queries -o 342.45 --tls-connect psk --tls-psk-identity "PSK ID
Zabbix agentd" --tls-psk-file /home/zabbix/zabbix_agentd.psk
SEE ALSO¶
zabbix_agentd(8), zabbix_get(1), zabbix_proxy(8), zabbix_server(8), zabbix_js(1), zabbix_agent2(8), zabbix_web_service(8)
2022-01-06 | Zabbix |