Jump to:navigation, search
Wiki

API Keys

From Securepoint Wiki




























In dieser Seite werden die Variablen für unterschiedliche Sprachen definiert.
Diese Seite wird auf folgenden Seiten eingebunden
























| Grafana Configuration }}





























Using API Keys for UTM Monitoring

Last adaptation to the version: 2.5

New:
Last updated: 
notempty
This article refers to a Beta version
-
Access: portal.securepoint.cloud General API Keys

Scope of functions

API Keys enable authentication in the USC Portal for other applications.
The API keys have a defined scope that currently only includes metrics for monitoring.
API Keys in the USC Portal
 Add API Key Adding a new API Key
 Copy to clipboard Copies the API key to the clipboard. From here it can be pasted into other applications.
 Hide expired API keys notempty
New as of: 1.28
 API keys that have expired can be hidden using this button. These API keys have the label  Expired.

Add API Key

 Add API Key
Caption Value Description
API Key
Name UTMs TTT-Point Meaningful name for the API key
For all Tenants
   When activated,    grants this API key access to all tenants
Clients TTT-Point AG Clients for which the API outputs values.
  • If no client is specified, values for all clients and the reseller itself are output!
    •  This field can not be changed afterwards
    Scope Metrics Scope for the API key. Currently only Metrics available
    This field can not be changed afterwards
    Expiration date Choose a date An expiration date must be selected.
    In case the validity period is to be changed later, it is only possible to delete the API key.
    This field can not be changed afterwards
    Comment     Free text field
      Save Creates the API key and closes the dialog.
  • The values for Client, Scope and Expiration Date cannot be changed afterwards.

    • Example of use





  • Note

    This article includes descriptions of third-party software and is based on the status at the time this page was created.
    Changes to the user interface on the part of the manufacturer are possible at any time and must be taken into account accordingly in the implementation.
    All information without warranty.

    • The following example assumes a working installation of:
    • Linux VM
    • Prometheus (Opensource Monitoring)
    • Grafana (Open source application for graphical representation of data)
    • ngninx (Webserver)
    notempty
    No support from our support for third-party products
    We do not provide any support for these applications and cannot provide any support for installation or configuration.
    Only application scenarios for API Keys are shown here.


    Edit Prometheus configuration

    Open the configuration file of Prometheus e.g. with editor nano sudo nano /etc/prometheus/prometheus.yml

    Section scrape_configs: notempty

    Updated to 10.2025
    In der vorhergehenden Version fehlten die Zeilen params:
    version: ['2.2']

    global: scrape_interval: 15s evaluation_interval: 15s scrape_configs: - job_name: 'securepoint_cloud_metrics_2.2' scrape_interval: 60s scrape_timeout: 30s metrics_path: '/sms-mgt-api/api/2.0/metrics' scheme: https bearer_token: 'eyJhbGciOiJIUzI1NiIsInR5c......' params: version: ['2.2'] static_configs: - targets: ['portal.securepoint.cloud']

  • The value of the API key (with apostrophes) is entered as bearer_token.

    •

    Then save configuration and restart the service. sudo systemctl restart prometheus

    The command sudo systemctl status prometheus.service shows if the service could start correctly.
    Exit the result display with the q key

    Opening the Prometheus page in the menu Status / Targets in the browser should provide a result similar to the one shown opposite.



    Grafana Configuration

    Add data source
    • Calling up Grafana in the web browser
    • In the side menu: Connections
      In older versions burger menu top left
    • Menu Data soures
    • Button: Add new data source
    • Choose Prometheus
    • Enter the URL of the Prometheus server with port, e.g: http://localhost:9090
    • Save with Save & test


    Configure Grafana Dashboard
    Example 1 - Graphical representation
    Example 1
    UTMs online/offline/firmware version (graphical representation)
    The result should look similar to this dashboard.
    • in the menu
    • Button  Import
    • Enter the following code in the field Import via panel json:

    { "__inputs": [ { "name": "DS_PROMETHEUS", "label": "Prometheus", "description": "", "type": "datasource", "pluginId": "prometheus", "pluginName": "Prometheus" } ], "__elements": {}, "__requires": [ { "type": "panel", "id": "gauge", "name": "Gauge", "version": "" }, { "type": "grafana", "id": "grafana", "name": "Grafana", "version": "9.3.6" }, { "type": "datasource", "id": "prometheus", "name": "Prometheus", "version": "1.0.0" }, { "type": "panel", "id": "table", "name": "Table", "version": "" }, { "type": "panel", "id": "timeseries", "name": "Time series", "version": "" } ], "annotations": { "list": [ { "builtIn": 1, "datasource": { "type": "grafana", "uid": "-- Grafana --" }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", "name": "Annotations & Alerts", "target": { "limit": 100, "matchAny": false, "tags": [], "type": "dashboard" }, "type": "dashboard" } ] }, "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, "id": 16, "links": [], "liveNow": false, "panels": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "text", "value": null }, { "color": "green", "value": 1 } ] } }, "overrides": [] }, "gridPos": { "h": 8, "w": 5, "x": 0, "y": 0 }, "id": 10, "options": { "orientation": "auto", "reduceOptions": { "calcs": [ "lastNotNull" ], "fields": "", "values": false }, "showThresholdLabels": false, "showThresholdMarkers": true }, "pluginVersion": "10.0.2", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "expr": "sum(utm_usc_online_total)", "legendFormat": "__auto", "range": true, "refId": "A" } ], "title": "UTMs online", "type": "gauge" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "green", "value": null }, { "color": "red", "value": 1 } ] } }, "overrides": [] }, "gridPos": { "h": 8, "w": 5, "x": 5, "y": 0 }, "id": 9, "options": { "orientation": "auto", "reduceOptions": { "calcs": [ "lastNotNull" ], "fields": "", "values": false }, "showThresholdLabels": false, "showThresholdMarkers": true }, "pluginVersion": "10.0.2", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "expr": "sum(utm_usc_offline_total)", "legendFormat": "__auto", "range": true, "refId": "A" } ], "title": "UTMs offline", "type": "gauge" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "palette-classic" }, "custom": { "hideFrom": { "legend": false, "tooltip": false, "viz": false } }, "mappings": [], "unit": "none" }, "overrides": [] }, "gridPos": { "h": 8, "w": 4, "x": 10, "y": 0 }, "id": 8, "options": { "legend": { "displayMode": "table", "placement": "bottom", "showLegend": true, "values": [ "value", "percent" ] }, "pieType": "pie", "reduceOptions": { "calcs": [ "lastNotNull" ], "fields": "", "values": false }, "tooltip": { "mode": "single", "sort": "none" } }, "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "exemplar": false, "expr": "sum by (version) (utm_usc_online_status{last_contact!=\"-1\"})", "format": "heatmap", "hide": false, "instant": false, "interval": "", "legendFormat": "{{label_name}}", "range": true, "refId": "A" } ], "title": "Firmware - Verteilung", "type": "piechart" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "palette-classic" }, "custom": { "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", "hideFrom": { "legend": false, "tooltip": false, "viz": false }, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, "scaleDistribution": { "type": "linear" }, "showPoints": "auto", "spanNulls": false, "stacking": { "group": "A", "mode": "none" }, "thresholdsStyle": { "mode": "off" } }, "decimals": 0, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "green", "value": null }, { "color": "red", "value": 80 } ] }, "unit": "UTMs" }, "overrides": [] }, "gridPos": { "h": 8, "w": 10, "x": 14, "y": 0 }, "id": 5, "options": { "legend": { "calcs": [], "displayMode": "list", "placement": "bottom", "showLegend": true }, "tooltip": { "mode": "single", "sort": "none" } }, "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "expr": "sum by (accountname) (utm_usc_online_status)", "legendFormat": "__auto", "range": true, "refId": "A" } ], "title": "UTMs online", "type": "timeseries" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "fixedColor": "dark-green", "mode": "thresholds" }, "custom": { "align": "left", "cellOptions": { "type": "auto" }, "inspect": false }, "mappings": [ { "options": { "0": { "index": 0, "text": "OFFLINE" }, "1": { "index": 1, "text": "ONLINE" }, "-1": { "index": 2, "text": "⁣" } }, "type": "value" } ], "max": 1, "thresholds": { "mode": "absolute", "steps": [ { "color": "dark-red", "value": null }, { "color": "dark-green", "value": 1 } ] }, "unit": "none" }, "overrides": [ { "matcher": { "id": "byName", "options": "Status" }, "properties": [ { "id": "custom.cellOptions", "value": { "mode": "gradient", "type": "color-background" } }, { "id": "custom.width", "value": 77 }, { "id": "custom.align", "value": "center" } ] }, { "matcher": { "id": "byName", "options": "device_id" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "UTM im Unified Security Portal anzeigen", "url": "https://portal.securepoint.cloud/sms/#show-tenant-${__data.fields.Domäne}-usc-utms-${__data.fields.Geräte-ID}" } ] } ] }, { "matcher": { "id": "byName", "options": "last_contact" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" } ] }, { "matcher": { "id": "byName", "options": "update" }, "properties": [ { "id": "custom.cellOptions", "value": { "mode": "gradient", "type": "color-background" } }, { "id": "mappings", "value": [ { "options": { "none": { "color": "transparent", "index": 1, "text": "Nicht verfügbar" } }, "type": "value" }, { "options": { "pattern": "\\s*", "result": { "color": "transparent", "index": 0, "text": "Nicht verfügbar" } }, "type": "regex" }, { "options": { "pattern": ".+", "result": { "color": "dark-green", "index": 2 } }, "type": "regex" } ] } ] }, { "matcher": { "id": "byName", "options": "WebSession" }, "properties": [ { "id": "mappings", "value": [ { "options": { "0": { "index": 0, "text": "⁣" }, "1": { "index": 1, "text": "Starte WebSession" } }, "type": "value" } ] }, { "id": "links", "value": [ { "title": "Starte WebSession", "url": "" } ] } ] }, { "matcher": { "id": "byName", "options": "virusscanner_lastrun" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" }, { "id": "mappings", "value": [] } ] }, { "matcher": { "id": "byName", "options": "virusscanner_updated" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" } ] }, { "matcher": { "id": "byName", "options": "update_version" }, "properties": [ { "id": "mappings", "value": [ { "options": { "none": { "color": "green", "index": 3 } }, "type": "value" }, { "options": { "pattern": "\\d+.*", "result": { "color": "yellow", "index": 0 } }, "type": "regex" }, { "options": { "pattern": ".+", "result": { "color": "transparent", "index": 1 } }, "type": "regex" }, { "options": { "match": "empty", "result": { "color": "transparent", "index": 2 } }, "type": "special" } ] }, { "id": "custom.cellOptions", "value": { "mode": "gradient", "type": "color-background" } } ] }, { "matcher": { "id": "byName", "options": "Hostname" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "", "url": "https://${__value.text}:11115" } ] } ] } ] }, "gridPos": { "h": 8, "w": 24, "x": 0, "y": 8 }, "id": 3, "options": { "cellHeight": "sm", "footer": { "countRows": false, "fields": "", "reducer": [ "sum" ], "show": false }, "showHeader": true, "sortBy": [ { "desc": false, "displayName": "Domäne" } ] }, "pluginVersion": "10.0.2", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "exemplar": false, "expr": "sort(utm_usc_online_status)", "format": "table", "hide": false, "instant": true, "legendFormat": "__auto", "range": false, "refId": "A" } ], "title": "UTMs", "transformations": [ { "id": "organize", "options": { "excludeByName": { "Time": true, "__name__": true, "instance": true, "job": true }, "indexByName": { "Time": 4, "Value": 3, "__name__": 5, "accountname": 1, "device_id": 9, "hostname": 2, "instance": 13, "job": 14, "last_contact": 6, "tenant_domain": 0, "update_version": 8, "version": 7, "virusscanner_lastrun": 11, "virusscanner_status": 10, "virusscanner_updated": 12 }, "renameByName": { "Time": "", "Value": "Status", "__name__": "", "accountname": "Account-Name", "device_id": "Geräte-ID", "hostname": "Hostname", "instance": "", "job": "", "last_contact": "Letzter Kontakt", "name": "UTM-Name", "tenant_domain": "Domäne", "update": "Firmware-Update", "update_version": "Update-Version", "version": "Firmware-Version", "virusscanner_lastrun": "Virusscanner-Lauf", "virusscanner_status": "Virusscanner-Status", "virusscanner_updated": "Virusscanner-Update" } } }, { "disabled": true, "id": "calculateField", "options": { "alias": "WebSession", "mode": "reduceRow", "reduce": { "include": [ "Status" ], "reducer": "last" } } }, { "id": "convertFieldType", "options": { "conversions": [ { "destinationType": "number", "targetField": "Letzter Kontakt" }, { "destinationType": "number", "targetField": "virusscanner_lastrun" }, { "destinationType": "number", "targetField": "virusscanner_updated" } ], "fields": {} } }, { "id": "organize", "options": { "excludeByName": {}, "indexByName": { "Account-Name": 1, "Domäne": 0, "Firmware-Version": 6, "Geräte-ID": 8, "Hostname": 2, "Letzter Kontakt": 5, "Status": 4, "Update-Version": 7, "Virusscanner-Lauf": 9, "Virusscanner-Status": 11, "Virusscanner-Update": 10, "WebSession": 3 }, "renameByName": {} } } ], "type": "table" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "custom": { "align": "left", "cellOptions": { "type": "auto" }, "filterable": true, "inspect": false }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "dark-red", "value": null }, { "color": "dark-orange", "value": 14 }, { "color": "dark-green", "value": 31 } ] } }, "overrides": [ { "matcher": { "id": "byName", "options": "Value" }, "properties": [ { "id": "custom.cellOptions", "value": { "mode": "gradient", "type": "color-background" } } ] }, { "matcher": { "id": "byName", "options": "Noch gültig" }, "properties": [ { "id": "unit", "value": "Tage" } ] }, { "matcher": { "id": "byName", "options": "NFR" }, "properties": [ { "id": "mappings", "value": [ { "options": { "false": { "index": 1, "text": "Nein" }, "true": { "index": 0, "text": "Ja" } }, "type": "value" } ] }, { "id": "custom.width", "value": 68 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-Typ" }, "properties": [ { "id": "custom.width", "value": 116 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-ID" }, "properties": [ { "id": "custom.width", "value": 89 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-ID" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "Lizenz im Reseller-Portal anzeigen", "url": "https://my.securepoint.de/2.0/licenses/${__data.fields.Lizenz-ID}" } ] } ] }, { "matcher": { "id": "byName", "options": "license_uuid" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "UTM im Unified Security Portal anzeigen", "url": "https://portal.securepoint.cloud/sms/#show-tenant-${__data.fields.Domäne}-usc-utms-${__data.fields.Geräte-ID}" } ] }, { "id": "custom.width", "value": 108 } ] }, { "matcher": { "id": "byName", "options": "Domäne" }, "properties": [ { "id": "custom.width", "value": 102 } ] } ] }, "gridPos": { "h": 14, "w": 24, "x": 0, "y": 16 }, "id": 1, "options": { "cellHeight": "sm", "footer": { "countRows": false, "fields": "", "reducer": [ "sum" ], "show": false }, "showHeader": true, "sortBy": [ { "desc": false, "displayName": "Noch gültig" } ] }, "pluginVersion": "10.0.2", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "exemplar": false, "expr": "utm_license_days_valid > 0", "format": "table", "hide": false, "instant": true, "interval": "", "key": "Q-9474a811-7756-42b1-ba32-22e507638503-0", "legendFormat": "{{label_name}}", "range": false, "refId": "A" } ], "title": "Lizenzen", "transformations": [ { "id": "filterFieldsByName", "options": { "include": { "names": [ "accountname", "license_creation_date", "license_displayname", "license_expiration_date", "license_id", "license_nfr", "license_type", "license_user", "license_uuid", "permission_affix", "tenant_domain", "Value" ] } } }, { "id": "organize", "options": { "excludeByName": { "permission_affix": true }, "indexByName": { "Value": 3, "accountname": 1, "license_creation_date": 4, "license_displayname": 2, "license_expiration_date": 5, "license_id": 6, "license_nfr": 7, "license_type": 8, "license_user": 9, "license_uuid": 10, "permission_affix": 11, "tenant_domain": 0 }, "renameByName": { "Value": "Noch gültig", "accountname": "Account-Name", "license_creation_date": "Erstellt am", "license_displayname": "Lizenz-Name", "license_expiration_date": "Gültig bis", "license_id": "Lizenz-ID", "license_nfr": "NFR", "license_type": "Lizenz-Typ", "license_user": "Anzahl Benutzer", "license_uuid": "Geräte-ID", "permission_affix": "", "tenant_domain": "Domäne" } } } ], "type": "table" } ], "refresh": "5m", "schemaVersion": 38, "style": "dark", "tags": [], "templating": { "list": [] }, "time": { "from": "now-2d", "to": "now" }, "timepicker": {}, "timezone": "", "title": "USC Monitoring I", "uid": "r38u25RRz", "version": 2, "weekStart": "" }

    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import


    Example 2 - UTMs Tabular representation
    Example 2
    UTMs Tabular representation
    Dashboard with graphical display of the UTM (online/offline/firmware version)
    • in the menu
    • Button  Import
    • Enter the following code in the field Import via panel json:

    { "__inputs": [ { "name": "DS_PROMETHEUS", "label": "Prometheus", "description": "", "type": "datasource", "pluginId": "prometheus", "pluginName": "Prometheus" } ], "__elements": {}, "__requires": [ { "type": "panel", "id": "gauge", "name": "Gauge", "version": "" }, { "type": "grafana", "id": "grafana", "name": "Grafana", "version": "9.3.6" }, { "type": "datasource", "id": "prometheus", "name": "Prometheus", "version": "1.0.0" }, { "type": "panel", "id": "table", "name": "Table", "version": "" }, { "type": "panel", "id": "timeseries", "name": "Time series", "version": "" } ], "annotations": { "list": [ { "builtIn": 1, "datasource": { "type": "grafana", "uid": "-- Grafana --" }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", "name": "Annotations & Alerts", "target": { "limit": 100, "matchAny": false, "tags": [], "type": "dashboard" }, "type": "dashboard" } ] }, "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, "id": null, "links": [], "liveNow": false, "panels": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "palette-classic" }, "custom": { "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", "hideFrom": { "legend": false, "tooltip": false, "viz": false }, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, "scaleDistribution": { "type": "linear" }, "showPoints": "auto", "spanNulls": false, "stacking": { "group": "A", "mode": "none" }, "thresholdsStyle": { "mode": "off" } }, "decimals": 0, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "green", "value": null }, { "color": "red", "value": 80 } ] }, "unit": "UTMs" }, "overrides": [] }, "gridPos": { "h": 5, "w": 20, "x": 0, "y": 0 }, "id": 5, "options": { "legend": { "calcs": [], "displayMode": "list", "placement": "bottom", "showLegend": true }, "tooltip": { "mode": "single", "sort": "none" } }, "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "expr": "sum(utm_usc_online_status == 1)", "legendFormat": "__auto", "range": true, "refId": "A" } ], "title": "UTMs online", "type": "timeseries" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, "decimals": 0, "mappings": [], "max": 100, "min": 0, "thresholds": { "mode": "absolute", "steps": [ { "color": "dark-red", "value": null }, { "color": "dark-green", "value": 100 } ] }, "unit": "string" }, "overrides": [] }, "gridPos": { "h": 5, "w": 4, "x": 20, "y": 0 }, "id": 7, "options": { "orientation": "auto", "reduceOptions": { "calcs": [ "last" ], "fields": "", "values": false }, "showThresholdLabels": false, "showThresholdMarkers": false }, "pluginVersion": "9.3.6", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "expr": "sum(utm_usc_online_status == 1)", "legendFormat": "__auto", "range": true, "refId": "A" } ], "title": "UTMs online", "type": "gauge" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "color": { "fixedColor": "dark-green", "mode": "thresholds" }, "custom": { "align": "left", "displayMode": "auto", "inspect": false }, "mappings": [ { "options": { "0": { "index": 0, "text": "OFFLINE" }, "1": { "index": 1, "text": "ONLINE" }, "-1": { "index": 2, "text": "⁣" } }, "type": "value" } ], "max": 1, "thresholds": { "mode": "absolute", "steps": [ { "color": "dark-red", "value": null }, { "color": "dark-green", "value": 1 } ] }, "unit": "none" }, "overrides": [ { "matcher": { "id": "byName", "options": "Status" }, "properties": [ { "id": "custom.displayMode", "value": "color-background" }, { "id": "custom.width", "value": 77 }, { "id": "custom.align", "value": "center" } ] }, { "matcher": { "id": "byName", "options": "device_id" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "UTM im Unified Security Portal anzeigen", "url": "https://portal.securepoint.cloud/sms/#show-tenant-${__data.fields.Domäne}-usc-utms-${__data.fields.Geräte-ID}" } ] } ] }, { "matcher": { "id": "byName", "options": "last_contact" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" } ] }, { "matcher": { "id": "byName", "options": "update" }, "properties": [ { "id": "custom.displayMode", "value": "color-background" }, { "id": "mappings", "value": [ { "options": { "none": { "color": "transparent", "index": 1, "text": "Nicht verfügbar" } }, "type": "value" }, { "options": { "pattern": "\\s*", "result": { "color": "transparent", "index": 0, "text": "Nicht verfügbar" } }, "type": "regex" }, { "options": { "pattern": ".+", "result": { "color": "dark-green", "index": 2 } }, "type": "regex" } ] } ] }, { "matcher": { "id": "byName", "options": "virusscanner_lastrun" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" } ] }, { "matcher": { "id": "byName", "options": "virusscanner_updated" }, "properties": [ { "id": "unit", "value": "dateTimeFromNow" } ] }, { "matcher": { "id": "byName", "options": "update_version" }, "properties": [ { "id": "mappings", "value": [ { "options": { "pattern": "\\d+.*", "result": { "color": "dark-green", "index": 0 } }, "type": "regex" }, { "options": { "pattern": ".+", "result": { "color": "transparent", "index": 1 } }, "type": "regex" }, { "options": { "match": "empty", "result": { "color": "transparent", "index": 2 } }, "type": "special" } ] }, { "id": "custom.displayMode", "value": "color-background" } ] } ] }, "gridPos": { "h": 8, "w": 24, "x": 0, "y": 5 }, "id": 3, "options": { "footer": { "fields": "", "reducer": [ "sum" ], "show": false }, "showHeader": true, "sortBy": [ { "desc": true, "displayName": "Update-Version" } ] }, "pluginVersion": "9.3.6", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "exemplar": false, "expr": "sort(utm_usc_online_status{})", "format": "table", "hide": false, "instant": true, "legendFormat": "__auto", "range": false, "refId": "A" } ], "title": "UTMs", "transformations": [ { "id": "organize", "options": { "excludeByName": { "Time": true, "__name__": true, "instance": true, "job": true }, "indexByName": { "Time": 4, "Value": 3, "__name__": 5, "accountname": 1, "device_id": 9, "hostname": 2, "instance": 13, "job": 14, "last_contact": 6, "tenant_domain": 0, "update_version": 8, "version": 7, "virusscanner_lastrun": 11, "virusscanner_status": 10, "virusscanner_updated": 12 }, "renameByName": { "Time": "", "Value": "Status", "__name__": "", "accountname": "Account-Name", "device_id": "Geräte-ID", "hostname": "Hostname", "instance": "", "job": "", "last_contact": "Letzter Kontakt", "name": "UTM-Name", "tenant_domain": "Domäne", "update": "Firmware-Update", "update_version": "Update-Version", "version": "Firmware-Version", "virusscanner_lastrun": "Virusscanner-Lauf", "virusscanner_status": "Virusscanner-Status", "virusscanner_updated": "Virusscanner-Update" } } }, { "id": "convertFieldType", "options": { "conversions": [ { "destinationType": "number", "targetField": "Letzter Kontakt" }, { "destinationType": "number", "targetField": "virusscanner_lastrun" }, { "destinationType": "number", "targetField": "virusscanner_updated" } ], "fields": {} } }, { "id": "organize", "options": { "excludeByName": {}, "indexByName": { "Account-Name": 1, "Domäne": 0, "Firmware-Version": 5, "Geräte-ID": 7, "Hostname": 2, "Letzter Kontakt": 4, "Status": 3, "Update-Version": 6, "Virusscanner-Lauf": 8, "Virusscanner-Status": 10, "Virusscanner-Update": 9 }, "renameByName": {} } } ], "type": "table" }, { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "fieldConfig": { "defaults": { "custom": { "align": "left", "displayMode": "auto", "inspect": false }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { "color": "dark-red", "value": null }, { "color": "dark-orange", "value": 30 }, { "color": "dark-green", "value": 60 } ] } }, "overrides": [ { "matcher": { "id": "byName", "options": "Value" }, "properties": [ { "id": "custom.displayMode", "value": "color-background" } ] }, { "matcher": { "id": "byName", "options": "Noch gültig" }, "properties": [ { "id": "unit", "value": "Tage" } ] }, { "matcher": { "id": "byName", "options": "NFR" }, "properties": [ { "id": "mappings", "value": [ { "options": { "false": { "index": 1, "text": "Nein" }, "true": { "index": 0, "text": "Ja" } }, "type": "value" } ] }, { "id": "custom.width", "value": 68 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-Typ" }, "properties": [ { "id": "custom.width", "value": 116 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-ID" }, "properties": [ { "id": "custom.width", "value": 89 } ] }, { "matcher": { "id": "byName", "options": "Lizenz-ID" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "Lizenz im Reseller-Portal anzeigen", "url": "https://my.securepoint.de/2.0/licenses/${__data.fields.Lizenz-ID}" } ] } ] }, { "matcher": { "id": "byName", "options": "license_uuid" }, "properties": [ { "id": "links", "value": [ { "targetBlank": true, "title": "UTM im Unified Security Portal anzeigen", "url": "https://portal.securepoint.cloud/sms/#show-tenant-${__data.fields.Domäne}-usc-utms-${__data.fields.Geräte-ID}" } ] }, { "id": "custom.width", "value": 108 } ] }, { "matcher": { "id": "byName", "options": "Domäne" }, "properties": [ { "id": "custom.width", "value": 102 } ] } ] }, "gridPos": { "h": 8, "w": 24, "x": 0, "y": 13 }, "id": 1, "options": { "footer": { "fields": "", "reducer": [ "sum" ], "show": false }, "showHeader": true, "sortBy": [] }, "pluginVersion": "9.3.6", "targets": [ { "datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" }, "editorMode": "code", "exemplar": false, "expr": "sort(utm_license_days_valid)", "format": "table", "hide": false, "instant": true, "interval": "", "key": "Q-9474a811-7756-42b1-ba32-22e507638503-0", "legendFormat": "__auto", "range": false, "refId": "A" } ], "title": "Lizenzen", "transformations": [ { "id": "filterFieldsByName", "options": { "include": { "names": [ "accountname", "license_creation_date", "license_displayname", "license_expiration_date", "license_id", "license_nfr", "license_type", "license_user", "license_uuid", "permission_affix", "tenant_domain", "Value" ] } } }, { "id": "organize", "options": { "excludeByName": { "permission_affix": true }, "indexByName": { "Value": 3, "accountname": 1, "license_creation_date": 4, "license_displayname": 2, "license_expiration_date": 5, "license_id": 6, "license_nfr": 7, "license_type": 8, "license_user": 9, "license_uuid": 10, "permission_affix": 11, "tenant_domain": 0 }, "renameByName": { "Value": "Noch gültig", "accountname": "Account-Name", "license_creation_date": "Erstellt am", "license_displayname": "Lizenz-Name", "license_expiration_date": "Gültig bis", "license_id": "Lizenz-ID", "license_nfr": "NFR", "license_type": "Lizenz-Typ", "license_user": "Anzahl Benutzer", "license_uuid": "Geräte-ID", "permission_affix": "", "tenant_domain": "Domäne" } } } ], "type": "table" } ], "refresh": "30s", "schemaVersion": 37, "style": "dark", "tags": [], "templating": { "list": [ { "datasource": { "type": "prometheus", "uid": "ftmKeWRRz" }, "filters": [], "hide": 0, "name": "Filters", "skipUrlSync": false, "type": "adhoc" } ] }, "time": { "from": "now-15m", "to": "now" }, "timepicker": {}, "timezone": "", "title": "USC Monitoring II", "uid": "r38u25RRz", "version": 43, "weekStart": "" }

    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import

    -->


    Dashboard with overview of the UTMs in operation (online/offline/USC active/firmware distribution/UTMs per end customer)

    Example 3 - UTM incl. USC
    Example 3
    notempty
    New as of v1.28
    UTM incl. USC
    • in the menu
    • Button  Import
    • Enter the following ID in the field Import via grafana.com: 20896
    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import



    Dashboard with useful information on licences (active/less than 30 days/expired)

    Example 4 - Overview of licences
    Example 4
    notempty
    New as of v1.28
    Overview of licences
    • in the menu
    • Button  Import
    • Enter the following ID in the field Import via grafana.com: 20898
    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import



    Dashboard with overview of the MDM (number/firmware distribution)

    Example 5 - MDM Dashboard
    Example 5
    notempty
    New as of v1.28
    MDM Dashboard
    Mobile devices with firmware versions
    • in the menu
    • Button  Import
    • Enter the following ID in the field Import via grafana.com: 20874
    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import



    Dashboard with overview of VPN connections/tunnels (MobSec connections/tunnel status/USC VPN connections)

    Example 6 - VPN overview
    Example 6
    notempty
    New as of v1.28
    VPN connections/tunnel overview
    • in the menu
    • Button  Import
    • Enter the following ID in the field Import via grafana.com: 20897
    • Button Load
    • Select data source: Select a Prometheus data source
    • Button Import



    Retrieved from "https://wiki.securepoint.de/index.php?title=USC/Api-Keys&oldid=99067"