> Proxy object
The following objects are directly related to the proxy
API.
Proxy
The proxy object has the following properties.
Property | Type | Description |
---|---|---|
proxyid | string | ID of the proxy. Property behavior: - read-only - required for update operations |
host | string | Name of the proxy. Property behavior: - required for create operations |
status | integer | Type of proxy. Possible values: 5 - active proxy; 6 - passive proxy. Property behavior: - required for create operations |
description | text | Description of the proxy. |
lastaccess | timestamp | Time when the proxy last connected to the server. Property behavior: - read-only |
tls_connect | integer | Connections to host. Possible values: 1 - (default) No encryption; 2 - PSK; 4 - certificate. |
tls_accept | integer | Connections from host. This is a bitmask field, any combination of possible bitmap values is acceptable. Possible bitmap values: 1 - (default) No encryption; 2 - PSK; 4 - certificate. |
tls_issuer | string | Certificate issuer. |
tls_subject | string | Certificate subject. |
tls_psk_identity | string | PSK identity. Do not put sensitive information in the PSK identity, it is transmitted unencrypted over the network to inform a receiver which PSK to use. Property behavior: - write-only - required if tls_connect is set to “PSK”, or tls_accept contains the “PSK” bit |
tls_psk | string | The preshared key, at least 32 hex digits. Property behavior: - write-only - required if tls_connect is set to “PSK”, or tls_accept contains the “PSK” bit |
proxy_address | string | Comma-delimited IP addresses or DNS names of active Zabbix proxy. |
auto_compress | integer | Indicates if communication between Zabbix server and proxy is compressed. Possible values: 0 - No compression; 1 - Compression enabled. Property behavior: - read-only |
version | integer | Version of proxy. Three-part Zabbix version number, where two decimal digits are used for each part, e.g., 50401 for version 5.4.1, 60200 for version 6.2.0, etc. 0 - Unknown proxy version. Property behavior: - read-only |
compatibility | integer | Version of proxy compared to Zabbix server version. Possible values: 0 - Undefined; 1 - Current version (proxy and server have the same major version); 2 - Outdated version (proxy version is older than server version, but is partially supported); 3 - Unsupported version (proxy version is older than server previous LTS release version or server major version is older than proxy major version). Property behavior: - read-only |
Proxy interface
The proxy interface object defines the interface used to connect to a passive proxy. It has the following properties.
Property | Type | Description |
---|---|---|
dns | string | DNS name to connect to. Can be empty if connections are made via IP address. Property behavior: - required if useip is set to “connect using DNS name” |
ip | string | IP address to connect to. Can be empty if connections are made via DNS names. Property behavior: - required if useip is set to “connect using IP address” |
port | string | Port number to connect to. Property behavior: - required |
useip | integer | Whether the connection should be made via IP address. Possible values: 0 - connect using DNS name; 1 - connect using IP address. Property behavior: - required |