fix(updates): "The syntax of the command is incorrect."

Author: markuslf

CHANGELOG.md

@@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 Monitoring Plugins:
 
 * disk-usage: handle disk accessibility ([#792](https://github.com/Linuxfabrik/monitoring-plugins/issues/792))
+* updates: "The syntax of the command is incorrect."
 
 
 ### Changed ("refactor", "chore" etc.)

check-plugins/updates/README.rst

@@ -17,15 +17,14 @@ Fact Sheet
     "Check Interval Recommendation",        "Once a day"
     "Can be called without parameters",     "Yes"
     "Compiled for Windows",                 "Yes"
-    "3rd Party Python modules",             "``psutil``"
 
 
 Help
 ----
 
 .. code-block:: text
 
-    usage: updates [-h] [-V] [--always-ok] [-c CRIT] [--timeout TIMEOUT] [-w WARN]
+    usage: updates [-h] [-V] [--always-ok] [-c CRIT] [-w WARN]
 
     Checks the number of pending Windows updates.
 
@@ -35,7 +34,6 @@ Help
       --always-ok          Always returns OK.
       -c, --critical CRIT  Set the critical threshold for the number of pending
                            updates. Default: 50
-      --timeout TIMEOUT    Network timeout in seconds. Default: 300 (seconds)
       -w, --warning WARN   Set the warning threshold for the number of pending
                            updates. Default: 2
 

check-plugins/updates/icingaweb2-module-director/updates.json

@@ -8,9 +8,6 @@
                 "--critical": {
                     "value": "$updates_windows_critical$"
                 },
-                "--timeout": {
-                    "value": "$updates_windows_timeout$"
-                },
                 "--warning": {
                     "value": "$updates_windows_warning$"
                 }
@@ -32,11 +29,6 @@
                     "datafield_id": 3,
                     "is_required": "n",
                     "var_filter": null
-                },
-                {
-                    "datafield_id": 4,
-                    "is_required": "n",
-                    "var_filter": null
                 }
             ],
             "imports": [],
@@ -110,7 +102,6 @@
                 "criticality": "C",
                 "updates_windows_always_ok": false,
                 "updates_windows_critical": 50,
-                "updates_windows_timeout": 300,
                 "updates_windows_warning": 2
             },
             "volatile": null,
@@ -140,17 +131,6 @@
             "uuid": "9188240c-b08e-450a-bb30-3388c215f68d"
         },
         "3": {
-            "varname": "updates_windows_timeout",
-            "caption": "Updates: Timeout",
-            "description": "Network timeout in seconds.",
-            "datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
-            "format": null,
-            "settings": {
-                "visibility": "visible"
-            },
-            "uuid": "de8dfdee-a209-40d3-95b7-239d22b1bed0"
-        },
-        "4": {
             "varname": "updates_windows_warning",
             "caption": "Updates: Warning",
             "description": "Set the warning threshold for the number of pending updates.",

check-plugins/updates/updates

@@ -16,18 +16,18 @@ import sys  # pylint: disable=C0413
 
 import lib.args  # pylint: disable=C0413
 import lib.base  # pylint: disable=C0413
-import lib.shell  # pylint: disable=C0413
-from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
-                          STATE_UNKNOWN, STATE_WARN)
+import lib.powershell  # pylint: disable=C0413
+import lib.txt  # pylint: disable=C0413
+from lib.globals import (STATE_OK, STATE_UNKNOWN)
+
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2023112901'
+__version__ = '2025061701'
 
 DESCRIPTION = 'Checks the number of pending Windows updates.'
 
-DEFAULT_CRIT = 50      # #updates
-DEFAULT_TIMEOUT = 300  # seconds
-DEFAULT_WARN = 2       # #updates
+DEFAULT_CRIT = 50  # #updates
+DEFAULT_WARN = 2   # #updates
 
 
 def parse_args():
@@ -38,7 +38,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='{0}: v{1} by {2}'.format('%(prog)s', __version__, __author__),
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -53,23 +53,25 @@ def parse_args():
         '-c', '--critical',
         default=DEFAULT_CRIT,
         dest='CRIT',
-        help='Set the critical threshold for the number of pending updates. Default: %(default)s',
+        help='Set the critical threshold for the number of pending updates. '
+             'Default: %(default)s',
         type=lib.args.int_or_none,
     )
 
     parser.add_argument(
         '--timeout',
-        help='Network timeout in seconds. Default: %(default)s (seconds)',
+        help=argparse.SUPPRESS,
         dest='TIMEOUT',
         type=int,
-        default=DEFAULT_TIMEOUT,
+        default=300,
     )
 
     parser.add_argument(
         '-w', '--warning',
         default=DEFAULT_WARN,
         dest='WARN',
-        help='Set the warning threshold for the number of pending updates. Default: %(default)s',
+        help='Set the warning threshold for the number of pending updates. '
+             'Default: %(default)s',
         type=lib.args.int_or_none,
     )
 
@@ -88,31 +90,34 @@ def main():
 
     # fetch data
     cmd = '''
-    powershell -Command "
     $WindowsUpdates = New-Object -ComObject 'Microsoft.Update.Session';
     $SearchIndex = $WindowsUpdates.CreateUpdateSearcher();
     $Pending = $SearchIndex.Search('IsInstalled=0');
     foreach ($update in $Pending.Updates) {
-        [string]$name = [string]::Format('{0} [{1}]', $update.Title, $update.LastDeploymentChangeTime);
+        $name = "{0} [{1}]" -f $update.Title, $update.LastDeploymentChangeTime;
         Write-Output $name;
     }
-    "'''
+    '''
 
     # execute the shell command and return its result and exit code
-    stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(cmd, timeout=args.TIMEOUT))
-    if stderr:
-        # Could not find any documentation in the return codes of 'query user'.
-        # Therefore we assume any is ok.
-        lib.base.cu(stderr)
-    result = stdout.strip()
+    result = lib.powershell.run_ps(cmd)
+    if not result:
+        lib.base.cu('Error calling PowerShell.')
+    if result['retc']:
+        lib.base.cu(result['stderr'])
+    result = result['stdout'].strip()
 
     count = sum(1 for line in result.splitlines())
     perfdata = lib.base.get_perfdata('pending_updates', count, None, args.WARN, args.CRIT, 0, None)
 
     if count:
         state = lib.base.get_state(count, args.WARN, args.CRIT)
         lib.base.oao(
-            'There are {} pending updates:\n\n* '.format(count) + result.replace('\n', '\n* '),
+            (
+                f"There {lib.txt.pluralize('', count, 'is,are')} {count} pending "
+                f"{lib.txt.pluralize('update', count)}:\n\n"
+                f"* {result.replace('\n', '\n* ')}"
+            ),
             state,
             perfdata,
             always_ok=args.ALWAYS_OK,