1 General

    Overview

    The list of available subsections appears upon pressing on General in the Administration menu section. It is also possible to switch between subsections by using the title dropdown in the top left corner.

    1 GUI

    This section provides customization of several frontend-related defaults.

    Configuration parameters:

    2 Autoregistration

    In this section, you can configure the encryption level for active agent autoregistration.

    adm_autoreg2.png

    Parameters marked with an asterisk are mandatory.

    Configuration parameters:

    ParameterDescription
    Encryption levelSelect one or both options for encryption level:
    No encryption - unencrypted connections are allowed
    PSK - TLS encrypted connections with a pre-shared key are allowed
    PSK identityEnter the pre-shared key identity string.
    This field is only available if ‘PSK’ is selected as Encryption level.
    Do not put sensitive information in the PSK identity, it is transmitted unencrypted over the network to inform a receiver which PSK to use.
    PSKEnter the pre-shared key (an even number of hexadecimal characters).
    Maximum length: 512 hex-digits (256-byte PSK) if Zabbix uses GnuTLS or OpenSSL library, 64 hex-digits (32-byte PSK) if Zabbix uses mbed TLS (PolarSSL) library.
    Example: 1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952
    This field is only available if ‘PSK’ is selected as Encryption level.

    See also:

    3 Housekeeper

    The housekeeper is a periodical process, executed by Zabbix server. The process removes outdated information and information deleted by user.

    In this section housekeeping tasks can be enabled or disabled on a per-task basis separately for: events and alerts/IT services/user sessions/history/trends. Audit housekeeping settings are available in a separate .

    If housekeeping is enabled, it is possible to set for how many days data records will be kept before being removed by the housekeeper.

    Deleting an item/trigger will also delete problems generated by that item/trigger.

    Also, an event will only be deleted by the housekeeper if it is not associated with a problem in any way. This means that if an event is either a problem or recovery event, it will not be deleted until the related problem record is removed. The housekeeper will delete problems first and events after, to avoid potential problems with stale events or problem records.

    For history and trends an additional option is available: Override item history period and Override item trend period. This option allows to globally set for how many days item history/trends will be kept (1 hour to 25 years; or “0”), in this case overriding the values set for individual items in History storage period/Trend storage period fields in item configuration. Note, that the storage period will not be overridden for items that have configuration option Do not keep history and/or Do not keep trends enabled.

    It is possible to override the history/trend storage period even if internal housekeeping is disabled. Thus, when using an external housekeeper, the history storage period could be set using the history Data storage period field.

    If using TimescaleDB, in order to take full advantage of TimescaleDB automatic partitioning of history and trends tables, Override item history period and Override item trend period options must be enabled as well as Enable internal housekeeping option for history and trends. Otherwise, the data kept in these tables will still be stored in partitions, however, the housekeeper will be cleaning the history and trends by deleting individual records rather than by dropping outdated partitions. When dropping of outdated partitions is enabled, Zabbix server and frontend will no longer keep track of deleted items and history for deleted items will be cleared when an outdated partition is deleted.

    are supported in the period fields, e.g. 1d (one day), 1w (one week). The minimum is 1 day (1 hour for history), the maximum - 25 years.

    4 Audit log

    This section allows configuring audit log settings.

    1 General - 图4

    The following parameters are available:

    ParameterDescription
    Enable audit loggingEnable/disable audit logging. Marked by default.
    Enable internal housekeepingEnable/disable internal housekeeping for audit. Marked by default.
    Data storage periodAmount of days audit records should be kept for before being removed by the housekeeper. Mandatory if housekeeping is enabled. Default: 365 days.

    5 Images

    The Images section displays all the images available in Zabbix. Images are stored in the database.

    The Type dropdown allows you to switch between icon and background images:

    • Icons are used to display network map elements
    • Backgrounds are used as background images of network maps

    Adding image

    You can add your own image by clicking on the Create icon or Create background button in the top right corner.

    1 General - 图6

    Image attributes:

    ParameterDescription
    NameUnique name of an image.
    UploadSelect the file (PNG, JPEG, GIF) from a local system to be uploaded to Zabbix.
    Note that it may be possible to upload other formats that will be converted to PNG during upload. GD library is used for image processing, therefore formats that are supported depend on the library version used (2.0.28 or higher is required by Zabbix).

    Maximum size of the upload file is limited by the value of ZBX_MAX_IMAGE_SIZE that is 1024x1024 bytes or 1 MB.

    The upload of an image may fail if the image size is close to 1 MB and the MySQL configuration parameter is at a default of 1MB. In this case, increase the parameter.

    6 Icon mapping

    This section allows creating the mapping of certain hosts with certain icons. Host inventory field information is used to create the mapping.

    The mappings can then be used in to assign appropriate icons to matching hosts automatically.

    To create a new icon map, click on Create icon map in the top right corner.

    Configuration parameters:

    7 Regular expressions

    This section allows creating custom regular expressions that can be used in several places in the frontend. See section for details.

    8 Macros

    This section allows to define system-wide as name-value pairs. Note that macro values can be kept as plain text, secret text or Vault secret. Adding a description is also supported.

    9 Trigger displaying options

    This section allows customizing how trigger status is displayed in the frontend and names and colors.

    1 General - 图9

    ParameterDescription
    Use custom event status colorsChecking this parameter turns on the customization of colors for acknowledged/unacknowledged problems.
    Unacknowledged PROBLEM events,
    Acknowledged PROBLEM events,
    Unacknowledged RESOLVED events,
    Acknowledged RESOLVED events    		Enter new color code or click on the color to select a new one from the provided palette.
    If blinking checkbox is marked, triggers will blink for some time upon the status change to become more visible.
    Display OK triggers forTime period for displaying OK triggers. Allowed range: 0 - 24 hours. Time suffixes, e.g. 5m, 2h, 1d, are supported.
    On status change triggers blink forLength of trigger blinking. Allowed range: 0 - 24 hours. , e.g. 5m, 2h, 1d, are supported.
    Not classified,
    Information,
    Warning,
    Average,
    High,
    Disaster    		Custom severity names and/or colors to display instead of system default.
    Enter new color code or click on the color to select a new one from the provided palette.

    Note, that custom severity names entered here will be used in all locales. If you need to translate them to other languages for certain users, see Customizing trigger severities page.

    10 Geographical maps

    This section allows selecting geographical map tile service provider and configuring service provider settings for the Geomap dashboard widget. To provide visualization using the geographical maps, Zabbix uses open-source JavaScript interactive maps library Leaflet. Please note that Zabbix has no control over the quality of images provided by third-party tile providers, including the predefined tile providers.

    ParameterDescription
    Tile providerSelect one of the available tile service providers or select Other to add another tile provider or self-hosted tiles (see ).
    Tile URLThe URL template for loading and displaying the tile layer on geographical maps. This field is editable only if Tile provider is set to Other.

    The following placeholders are supported:
    {s} represents one of the available subdomains;
    {z} represents zoom level parameter in the URL;
    {x} and {y} represent tile coordinates;
    {r} can be used to add “@2x” to the URL to load retina tiles.

    Example:
    AttributionTile provider attribution data to be displayed in a small text box on the map. This field is editable only if Tile provider is set to Other.
    Max zoom levelMaximum zoom level of the map. This field is editable only if Tile provider is set to Other.
    Using a custom tile service provider

    The Geomap widget is capable to load raster tile images from a custom self-hosted or a third-party tile provider service. To use a custom third-party tile provider service or a self-hosted tile folder or server, select Other in the Tile provider field and specify the custom URL in the Tile URL field using proper placeholders.

    11 Modules

    This section allows to administer custom frontend modules.

    1 General - 图11

    Click on Scan directory to register/unregister any custom modules. Registered modules will appear in the list, along with their details. Unregistered modules will be removed from the list.

    You may filter modules by name or status (enabled/disabled). Click on the module status in the list to enable/disable a module. You may also mass enable/disable modules by selecting them in the list and then clicking on the Enable/Disable buttons below the list.

    12 API tokens

    This section allows to create and manage API tokens.

    You may filter API tokens by name, users to whom the tokens are assigned, expiry date, users that created tokens, or status (enabled/disabled). Click on the token status in the list to quickly enable/disable a token. You may also mass enable/disable tokens by selecting them in the list and then clicking on the Enable/Disable buttons below the list.

    To create a new token, press Create API token button at the top right corner, then fill out the required fields in the token configuration screen:

    1 General - 图13

    ParameterDescription
    NameToken’s visible name.
    UserUser the token should be assigned to. To quickly select a user, start typing the username, first or last name, then select the required user from the auto-complete list. Alternatively, you can press the Select button and select a user from the full user list. A token can be assigned only to one user.
    DescriptionOptional token description.
    Set expiration date and timeUnmark this checkbox if a token should not have an expiry date.
    Expiry dateClick on the calendar icon to select token expiry date or enter the date manually in a format YYYY-MM-DD hh:mm:ss
    EnabledUnmark this checkbox if you need to create a token in a disabled state.

    Press Add to create a token. On the next screen, copy and save in a safe place Auth token value before closing the page, then press Close. The token will appear in the list.

    Auth token value cannot be viewed again later. It is only available immediately after creating a token. If you lose a saved token you will have to regenerate it and doing so will create a new authorization string.

    Click on the token name to edit the name, description, expiry date settings, or token status. Note, that it is not possible to change to which user the token is assigned. Press Update button to save changes. If a token has been lost or exposed, you may press Regenerate button to generate new token value. A confirmation dialog box will appear, asking you to confirm this operation since after proceeding the previously generated token will become invalid.

    Users without access to the Administration menu section can see and modify details of tokens assigned to them in the User profile → API tokens section only if Manage API tokens is allowed in their permissions.

    13 Other parameters

    This section allows configuring miscellaneous other frontend parameters.

    Authorization
    ParameterDescription
    Login attemptsNumber of unsuccessful login attempts before the possibility to log in gets blocked.
    Login blocking intervalPeriod of time for which logging in will be prohibited when Login attempts limit is exceeded.
    Security
    ParameterDescription
    Validate URI schemesUncheck the box to disable URI scheme validation against the whitelist defined in Valid URI schemes. (enabled by default).
    Valid URI schemesA comma-separated list of allowed URI schemes. Applies to all fields in the frontend where URIs are used (for example, map element URLs).
    this field is editable only if Validate URI schemes is selected.
    X-Frame-Options HTTP headerValue of HTTP X-Frame-options header. Supported values:
    SAMEORIGIN (default) - the page can only be displayed in a frame on the same origin as the page itself.
    DENY - the page cannot be displayed in a frame, regardless of the site attempting to do so.
    null - disable X-Frame-options header (not recommended).
    Or a list (string) of comma-separated hostnames. If a listed hostname is not among allowed, the SAMEORIGIN option is used.
    Use iframe sandboxingThis parameter determines whether retrieved URL content should be put into the sandbox or not. Note, that turning off sandboxing is not recommended.
    Iframe sandboxing exceptionsIf sandboxing is enabled and this field is empty, all sandbox attribute restrictions apply. To disable some of the restrictions, specified them in this field. This disables only restrictions listed here, other restrictions will still be applied. See description for additional information.
    Communication with Zabbix server
    ParameterDescription
    Network timeoutHow many seconds to wait before closing an idle socket (if a connection to Zabbix server has been established earlier, but frontend can not finish read/send data operation during this time, the connection will be dropped). Allowed range: 1 - 300s (default: 3s).
    Connection timeoutHow many seconds to wait before stopping an attempt to connect to Zabbix server. Allowed range: 1 - 30s (default: 3s).
    Network timeout for media type testHow many seconds to wait for a response when testing a media type. Allowed range: 1 - 300s (default: 65s).
    Network timeout for script executionHow many seconds to wait for a response when executing a script. Allowed range: 1 - 300s (default: 60s).
    Network timeout for item testHow many seconds to wait for returned data when testing an item. Allowed range: 1 - 300s (default: 60s).
    Network timeout for scheduled report testHow many seconds to wait for returned data when testing a scheduled report. Allowed range: 1 - 300s (default: 60s).