feat(infomaniak-swiss-backup-devices): add --ignore-customer, --ignore-name, --ignore-tag, --ignore-user parameters

Author: NavidSassan

CHANGELOG.md

@@ -32,6 +32,7 @@ Monitoring Plugins:
 
 * by-ssh: add alerting on single numeric values
 * by-winrm: executes commands on remote Windows hosts by WinRM, supporting JEA (including the JEA endpoint via `--winrm-configuration-name`)
+* infomaniak-swiss-backup-devices: add `--ignore-customer`, `--ignore-name`, `--ignore-tag`, `--ignore-user` parameters to skip devices by regex
 * nextcloud-enterprise: provides information about an installed Nextcloud Enterprise subscription
 * statuspal: also detect 'emergency-maintenance' state
 * valkey-status: support user and password credentials [PR #954](https://github.com/Linuxfabrik/monitoring-plugins/pull/954), thanks to [Claudio Kuenzler](https://github.com/Napsty)

check-plugins/infomaniak-swiss-backup-devices/README.md

@@ -33,7 +33,12 @@ Links:
 ```text
 usage: infomaniak-swiss-backup-devices [-h] [-V] --account-id ACCOUNT_ID
                                        [--always-ok] [-c CRIT] [--insecure]
-                                       [--no-proxy] [--severity {warn,crit}]
+                                       [--no-proxy]
+                                       [--ignore-customer IGNORE_CUSTOMER]
+                                       [--ignore-name IGNORE_NAME]
+                                       [--ignore-tag IGNORE_TAG]
+                                       [--ignore-user IGNORE_USER]
+                                       [--severity {warn,crit}]
                                        [--timeout TIMEOUT] --token TOKEN
                                        [--test TEST] [-w WARN]
 
@@ -50,6 +55,22 @@ options:
   --insecure            This option explicitly allows to perform "insecure"
                         SSL connections. Default: False
   --no-proxy            Do not use a proxy. Default: False
+  --ignore-customer IGNORE_CUSTOMER
+                        Any device whose product customer name matches this
+                        python regex will be ignored (repeating). Example:
+                        '(?i)test' for a case-insensitive search for "test".
+  --ignore-name IGNORE_NAME
+                        Any device whose name matches this python regex will
+                        be ignored (repeating). Example: '(?i)old-backup' for
+                        a case-insensitive search for "old-backup".
+  --ignore-tag IGNORE_TAG
+                        Any device whose product tag matches this python regex
+                        will be ignored (repeating). Example: '(?i)deprecated'
+                        for a case-insensitive search for "deprecated".
+  --ignore-user IGNORE_USER
+                        Any device whose username matches this python regex
+                        will be ignored (repeating). Example: '(?i)testuser'
+                        for a case-insensitive search for "testuser".
   --severity {warn,crit}
                         Severity for alerting other values. Default: warn
   --timeout TIMEOUT     Network timeout in seconds. Default: 8 (seconds)

check-plugins/infomaniak-swiss-backup-devices/infomaniak-swiss-backup-devices

@@ -13,6 +13,7 @@
 
 import argparse  # pylint: disable=C0413
 import json  # pylint: disable=C0413
+import re  # pylint: disable=C0413
 import sys  # pylint: disable=C0413
 
 import lib.args  # pylint: disable=C0413
@@ -26,7 +27,7 @@ from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
                           STATE_UNKNOWN, STATE_WARN)
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040701'
 
 DESCRIPTION = """Checks each device / slot of all your Infomaniak Swiss backup products via the
                  Infomaniak API."""
@@ -92,6 +93,46 @@ def parse_args():
         default=DEFAULT_NO_PROXY,
     )
 
+    parser.add_argument(
+        '--ignore-customer',
+        help='Any device whose product customer name matches this python regex will be ignored '
+             '(repeating). '
+             'Example: \'(?i)test\' for a case-insensitive search for "test".',
+        action='append',
+        default=None,
+        dest='IGNORE_CUSTOMER',
+    )
+
+    parser.add_argument(
+        '--ignore-name',
+        help='Any device whose name matches this python regex will be ignored '
+             '(repeating). '
+             'Example: \'(?i)old-backup\' for a case-insensitive search for "old-backup".',
+        action='append',
+        default=None,
+        dest='IGNORE_NAME',
+    )
+
+    parser.add_argument(
+        '--ignore-tag',
+        help='Any device whose product tag matches this python regex will be ignored '
+             '(repeating). '
+             'Example: \'(?i)deprecated\' for a case-insensitive search for "deprecated".',
+        action='append',
+        default=None,
+        dest='IGNORE_TAG',
+    )
+
+    parser.add_argument(
+        '--ignore-user',
+        help='Any device whose username matches this python regex will be ignored '
+             '(repeating). '
+             'Example: \'(?i)testuser\' for a case-insensitive search for "testuser".',
+        action='append',
+        default=None,
+        dest='IGNORE_USER',
+    )
+
     parser.add_argument(
         '--severity',
         help='Severity for alerting other values. '
@@ -147,6 +188,16 @@ def main():
     except SystemExit:
         sys.exit(STATE_UNKNOWN)
 
+    # set default values for append parameters that were not specified
+    if args.IGNORE_CUSTOMER is None:
+        args.IGNORE_CUSTOMER = []
+    if args.IGNORE_NAME is None:
+        args.IGNORE_NAME = []
+    if args.IGNORE_TAG is None:
+        args.IGNORE_TAG = []
+    if args.IGNORE_USER is None:
+        args.IGNORE_USER = []
+
     # fetch list of products
     if args.TEST is None:
         slots = lib.base.coe(lib.infomaniak.get_swiss_backup_slots(
@@ -166,10 +217,27 @@ def main():
     state = STATE_OK
     perfdata = ''
     table_data = []
+    compiled_ignore_customer = [re.compile(item) for item in args.IGNORE_CUSTOMER]
+    compiled_ignore_name = [re.compile(item) for item in args.IGNORE_NAME]
+    compiled_ignore_tag = [re.compile(item) for item in args.IGNORE_TAG]
+    compiled_ignore_user = [re.compile(item) for item in args.IGNORE_USER]
 
     # analyze data
     for slot in slots:
         for slot_data in slot.get('data'):
+            # ignore devices matching any --ignore-* parameter
+            if any(item.search(slot.get('product_customer_name', '')) for item in compiled_ignore_customer): # pylint: disable=C0301
+                continue
+            if any(item.search(slot_data.get('customer_name', '')) for item in compiled_ignore_name):
+                continue
+            if any(
+                item.search(tag['name'])
+                for item in compiled_ignore_tag
+                for tag in slot.get('product_tags', [])
+            ):
+                continue
+            if any(item.search(slot_data.get('username', '')) for item in compiled_ignore_user):
+                continue
             if slot_data.get('storage_used', 0):
                 used = round(slot_data.get('storage_used') / slot_data.get('size') * 100, 1)
                 used_state = lib.base.get_state(used, args.WARN, args.CRIT)

check-plugins/infomaniak-swiss-backup-devices/unit-test/run

@@ -71,5 +71,40 @@ class TestCheck(unittest.TestCase):
         self.assertEqual(retc, STATE_CRIT)
 
 
+    def test_if_check_runs_EXAMPLE02_ignore_customer(self):
+        stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(self.check + ' --token=TOKEN --account-id=ACCOUNT-ID --ignore-customer=\'BK-200999-1$\' --test=stdout/EXAMPLE02,,0'))
+        self.assertIn('Everything is ok.', stdout)
+        self.assertNotIn('99904', stdout)
+        self.assertIn('99924', stdout)
+        self.assertEqual(stderr, '')
+        self.assertEqual(retc, STATE_OK)
+
+    def test_if_check_runs_EXAMPLE02_ignore_name(self):
+        stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(self.check + ' --token=TOKEN --account-id=ACCOUNT-ID --ignore-name=\'^test$\' --test=stdout/EXAMPLE02,,0'))
+        self.assertIn('Everything is ok.', stdout)
+        self.assertNotIn('99925', stdout)
+        self.assertNotIn('99931', stdout)
+        self.assertNotIn('99945', stdout)
+        self.assertIn('99924', stdout)
+        self.assertEqual(stderr, '')
+        self.assertEqual(retc, STATE_OK)
+
+    def test_if_check_runs_EXAMPLE02_ignore_tag(self):
+        stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(self.check + ' --token=TOKEN --account-id=ACCOUNT-ID --ignore-tag=\'^tag01$\' --test=stdout/EXAMPLE02,,0'))
+        self.assertIn('Everything is ok.', stdout)
+        self.assertNotIn('99904', stdout)
+        self.assertIn('99924', stdout)
+        self.assertEqual(stderr, '')
+        self.assertEqual(retc, STATE_OK)
+
+    def test_if_check_runs_EXAMPLE02_ignore_user(self):
+        stdout, stderr, retc = lib.base.coe(lib.shell.shell_exec(self.check + ' --token=TOKEN --account-id=ACCOUNT-ID --ignore-user=\'SBI-AB123456\' --test=stdout/EXAMPLE02,,0'))
+        self.assertIn('Everything is ok.', stdout)
+        self.assertNotIn('99904', stdout)
+        self.assertNotIn('99924', stdout)
+        self.assertEqual(stderr, '')
+        self.assertEqual(retc, STATE_OK)
+
+
 if __name__ == '__main__':
     unittest.main()