Skip to content

Check grassfish-licenses

Overview

Monitors available Grassfish digital signage licenses via the Grassfish API. Alerts when no more licenses of any type are available. Requires a Grassfish hostname and API token.

Important Notes:

  • Tested with Grassfish API v1.12
  • May take more than 10 seconds to execute depending on the API response time. Consider increasing --timeout if needed.

Data Collection:

  • Queries the Grassfish API (/gv2/webservices/API by default) to retrieve all license types and their availability
  • Reports total, used, and available license counts per type

Fact Sheet

Fact Value
Check Plugin Download https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/grassfish-licenses
Nagios/Icinga Check Name check_grassfish_licenses
Check Interval Recommendation Every hour
Can be called without parameters No (--hostname and --token are required)
Runs on Cross-platform
Compiled for Windows No

Help

usage: grassfish-licenses [-h] [-V] [--always-ok] [--api-version API_VERSION]
                          -H HOSTNAME [--insecure] [--no-proxy] [--port PORT]
                          [--test TEST] [--timeout TIMEOUT] --token TOKEN
                          [-u URL]

Monitors available Grassfish digital signage licenses via the Grassfish API.
Alerts when no more licenses are available. Requires a Grassfish hostname and
API token.

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  --always-ok           Always returns OK.
  --api-version API_VERSION
                        Grassfish API version. Default: 1.12
  -H, --hostname HOSTNAME
                        Grassfish hostname.
  --insecure            This option explicitly allows insecure SSL
                        connections.
  --no-proxy            Do not use a proxy.
  --port PORT           Grassfish port number. Default: 443
  --test TEST           For unit tests. Needs "path-to-stdout-file,path-to-
                        stderr-file,expected-retc".
  --timeout TIMEOUT     Network timeout in seconds. Default: 8 (seconds)
  --token TOKEN         Grassfish API token.
  -u, --url URL         Grassfish API URL. Default: /gv2/webservices/API

Usage Examples

./grassfish-licenses --hostname=ds.example.com --token=TOKEN

Output:

Everything is ok.

License Type     ! Usage                     
-----------------+---------------------------
Player           ! 9/10 (1 available)        
DsPlayerEntry    ! 1156/1400 (244 available) 
DsPlayerAdvanced ! 283/400 (117 available)   
DsPlayerPro      ! 820/843 (23 available)    
EntryPlayer      ! 51/100 (49 available)     
AdvancedPlayer   ! 25/150 (125 available)

States

  • OK if all license types have at least one available license.
  • WARN if no more licenses of any type are available.
  • --always-ok suppresses all alerts and always returns OK.

Perfdata / Metrics

Name Type Description
grassfish_lic_advancedplayer_used Number AdvancedPlayer licenses used.
grassfish_lic_dsplayeradvanced_used Number DsPlayerAdvanced licenses used.
grassfish_lic_dsplayerentry_used Number DsPlayerEntry licenses used.
grassfish_lic_dsplayerpro_used Number DsPlayerPro licenses used.
grassfish_lic_entryplayer_used Number EntryPlayer licenses used.
grassfish_lic_player_used Number Player licenses used.

Note: Metric names are dynamically generated from the license type name (lowercased). The exact names depend on the license types returned by the API.

Credits, License