Ceph plugin

Overview

Configuration parameters allow customizing the Ceph plugin behavior.

It is recommended to specify them in their own configuration file (e.g. ceph.conf), rather than in the agent 2 configuration file. Then use the Include directive to include this file in the Zabbix agent 2 configuration.

All parameters are optional, unless explicitly stated that the parameter is mandatory.

This page is structured as:

• Parameter overview (to see full details of a parameter, click its name)
• Parameter details

Note that:

• The default values reflect process defaults, not the values in the shipped configuration files;
• Values support environment variables;
• Zabbix supports configuration files only in UTF-8 encoding without BOM;
• Comments starting with "#" are only supported at the beginning of the line.

Parameter details

Plugins.Ceph.Default.ApiKey

Specify the default API key for connecting to Ceph.
Used if no value is specified in an item key or named session.

Plugins.Ceph.Default.Mode

Specify the default mode for connecting to Ceph.
The native mode is only supported on Linux and starting with Ceph 16. The restful mode will not work with Ceph version 20 or newer.
Note that the user credential set differs for each mode and they are not compatible with each other.

Default: restful (deprecated)
Range: native/restful

Plugins.Ceph.Default.URI

Specify the default URI for connecting to Ceph.
Used if no value is specified in an item key or named session.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only https scheme is supported; a scheme can be omitted.
A port can be omitted (default=8003).

Default: https://localhost:8003

Examples:

https://127.0.0.1:8003
localhost

Plugins.Ceph.Default.User

Specify the default user name for connecting to Ceph.
Used if no value is specified in an item key or named session.

Plugins.Ceph.InsecureSkipVerify

Specify whether an HTTP client should verify the server's certificate chain and host name.
If true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks (use only for testing).

Default: false
Range: false/true

Plugins.Ceph.KeepAlive

Set the maximum waiting time (in seconds) before unused plugin connections are closed.

Default: 300
Range: 60-900

Plugins.Ceph.Sessions.<SessionName>.ApiKey

Specify the named session API key for connecting to Ceph.
<SessionName> - define name of a session for using in item keys.

Plugins.Ceph.Sessions.<SessionName>.Mode

Specify the named session mode for connecting to Ceph.
<SessionName> - define name of a session for using in item keys.
The native mode is only supported on Linux and starting with Ceph 16. The restful mode will not work with Ceph version 20 or newer.
Note that the user credential set differs for each mode and they are not compatible with each other.

Default: restful (deprecated)
Range: native/restful

Plugins.Ceph.Sessions.<SessionName>.URI

Specify the named session URI for connecting to Ceph.
<SessionName> - define name of a session for using in item keys.
Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only https scheme is supported; a scheme can be omitted.
A port can be omitted (default=8003).

Default: https://localhost:8003

Examples:

https://127.0.0.1:8003
localhost

Plugins.Ceph.Sessions.<SessionName>.User

Specify the named session user name for connecting to Ceph.
<SessionName> - define name of a session for using in item keys.

Plugins.Ceph.Timeout

Set the request execution timeout (duration to wait for a request to complete before shutting it down) in seconds.

Default: global timeout
Range: 1-30

See also

• Instructions for configuring plugins
• Description of general Zabbix agent 2 configuration parameters: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)