{ "code_name": "icmp_scan", "unique_prefix": "ICMP", "plugin_type": "other", "execution_order" : "Layer_4", "enabled": true, "data_source": "script", "mapped_to_table": "CurrentScan", "show_ui": true, "data_filters": [ { "compare_column": "Object_PrimaryID", "compare_operator": "==", "compare_field_id": "txtMacFilter", "compare_js_template": "'{value}'.toString()", "compare_use_quotes": true } ], "localized": ["display_name", "description", "icon"], "display_name": [ { "language_code": "en_us", "string": "ICMP (Status check)" } ], "icon": [ { "language_code": "en_us", "string": "" } ], "description": [ { "language_code": "en_us", "string": "A plugin to check the status of the device." } ], "params": [ { "name": "ips", "type": "sql", "value": "SELECT devLastIP from DEVICES order by devMac", "timeoutMultiplier": true } ], "settings": [ { "function": "RUN", "events": ["run"], "type": { "dataType": "string", "elements": [ { "elementType": "select", "elementOptions": [], "transformers": [] } ] }, "default_value": "disabled", "options": [ "disabled", "on_new_device", "once", "schedule", "always_after_scan" ], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "When to run" } ], "description": [ { "language_code": "en_us", "string": "Enable a regular scan of your devices with PING to determine their status. If you select schedule the interval from below is applied, for which the recommendation is to align all scan schedules otherwise false down reports will be generated." } ] }, { "function": "MODE", "events": ["run"], "type": { "dataType": "string", "elements": [ { "elementType": "select", "elementOptions": [], "transformers": [] } ] }, "default_value": "fping", "options": [ "fping", "ping" ], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Mode" } ], "description": [ { "language_code": "en_us", "string": "Selects the ICMP engine to use. ping checks devices individually, works even with an empty ARP/neighbor cache, but is slower on large networks. fping scans IP ranges in parallel and is much faster, but depends on the system neighbor cache, which can delay MAC resolution. For most networks, fping is recommended, unless precise and timely offline/online detection is needed. Default ICMP_ARGS work with both engines." } ] }, { "function": "CMD", "type": { "dataType": "string", "elements": [ { "elementType": "input", "elementOptions": [{ "readonly": "true" }], "transformers": [] } ] }, "default_value": "python3 /app/front/plugins/icmp_scan/icmp.py", "options": [], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Command" } ], "description": [ { "language_code": "en_us", "string": "Command to run. This can not be changed" } ] }, { "function": "ARGS", "type": { "dataType": "string", "elements": [ { "elementType": "input", "elementOptions": [], "transformers": [] } ] }, "default_value": "-i 0.5 -c 3", "options": [], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Command arguments" } ], "description": [ { "language_code": "en_us", "string": "Arguments passed to the underlying ping or fping command. The default values (-i 0.5 -c 3) are compatible with both modes and work well in most environments. Modify with care, and consult the relevant manual pages if advanced tuning is required." } ] }, { "function": "IN_REGEX", "type": { "dataType": "string", "elements": [ { "elementType": "input", "elementOptions": [], "transformers": [] } ] }, "default_value": ".*", "options": [], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Inclusion REGEX" } ], "description": [ { "language_code": "en_us", "string": "REGEX to specify which IPs are included in the scan. Examples: 192.168.1.*|10.0.0.1|172.16.5.* (specific IPs or ranges). Use .* to include all IPs." } ] }, { "function": "FAKE_MAC", "type": { "dataType": "boolean", "elements": [ { "elementType": "input", "elementOptions": [ { "type": "checkbox" } ], "transformers": [] } ] }, "default_value": false, "options": [], "localized": [ "name", "description" ], "name": [ { "language_code": "en_us", "string": "Fake MAC" } ], "description": [ { "language_code": "en_us", "string": "If enabled and the mode is set to fping, the plugin will also discover new devices not already in the database. Enabling this setting generates a fake MAC address from the IP address to track devices. This may cause inconsistencies if IPs change or devices are re-discovered with a different MAC. Static IPs are recommended. Device type and icon might not be detected correctly, and some plugins may fail if they rely on a valid MAC address. When unchecked, devices without a MAC address are skipped." } ] }, { "function": "RUN_SCHD", "type": { "dataType": "string", "elements": [ { "elementType": "span", "elementOptions": [ { "cssClasses": "input-group-addon validityCheck" }, { "getStringKey": "Gen_ValidIcon" } ], "transformers": [] }, { "elementType": "input", "elementOptions": [ { "focusout": "validateRegex(this)" }, { "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ=" } ], "transformers": [] } ] }, "default_value": "*/5 * * * *", "options": [], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Schedule" } ], "description": [ { "language_code": "en_us", "string": "Only enabled if you select schedule in the ICMP_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes." } ] }, { "function": "RUN_TIMEOUT", "type": { "dataType": "integer", "elements": [ { "elementType": "input", "elementOptions": [{ "type": "number" }], "transformers": [] } ] }, "default_value": 10, "options": [], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Run timeout" } ], "description": [ { "language_code": "en_us", "string": "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted." } ] }, { "function": "SET_ALWAYS", "type": { "dataType": "array", "elements": [ { "elementType": "select", "elementOptions": [{ "multiple": "true", "ordeable": "true" }], "transformers": [] } ] }, "default_value": ["devMac", "devLastIP"], "options": [ "devMac", "devLastIP" ], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Set always columns" } ], "description": [ { "language_code": "en_us", "string": "These columns are treated as authoritative and will overwrite existing values, including those set by other plugins, unless the current value was explicitly set by the user (Source = USER or Source = LOCKED)." } ] }, { "function": "SET_EMPTY", "type": { "dataType": "array", "elements": [ { "elementType": "select", "elementOptions": [{ "multiple": "true", "ordeable": "true" }], "transformers": [] } ] }, "default_value": [], "options": [ "devMac", "devLastIP", "devName", "devSourcePlugin" ], "localized": ["name", "description"], "name": [ { "language_code": "en_us", "string": "Set empty columns" } ], "description": [ { "language_code": "en_us", "string": "These columns are only overwritten if they are empty (NULL / empty string) or if their Source is set to NEWDEV" } ] } ], "database_column_definitions": [ { "column": "Index", "css_classes": "col-sm-2", "show": true, "type": "none", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Index" } ] }, { "column": "Object_PrimaryID", "mapped_to_column": "scanMac", "css_classes": "col-sm-3", "show": true, "type": "device_name_mac", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "MAC (name)" } ] }, { "column": "Object_SecondaryID", "mapped_to_column": "scanLastIP", "css_classes": "col-sm-2", "show": true, "type": "device_ip", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "IP" } ] }, { "column": "Watched_Value1", "css_classes": "col-sm-2", "show": true, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Name" } ] }, { "column": "Watched_Value2", "css_classes": "col-sm-2", "show": true, "type": "textarea_readonly", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Output" } ] }, { "column": "Watched_Value3", "css_classes": "col-sm-2", "show": false, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "N/A" } ] }, { "column": "Watched_Value4", "css_classes": "col-sm-2", "show": false, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "N/A" } ] }, { "column": "Dummy", "mapped_to_column": "scanSourcePlugin", "mapped_to_column_data": { "value": "ICMP" }, "css_classes": "col-sm-2", "show": false, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Scan method" } ] }, { "column": "DateTimeCreated", "css_classes": "col-sm-2", "show": true, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Created" } ] }, { "column": "DateTimeChanged", "css_classes": "col-sm-2", "show": true, "type": "label", "default_value": "", "options": [], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Changed" } ] }, { "column": "Status", "css_classes": "col-sm-1", "show": true, "type": "replace", "default_value": "", "options": [ { "equals": "watched-not-changed", "replacement": "
" }, { "equals": "watched-changed", "replacement": "
" }, { "equals": "new", "replacement": "
" }, { "equals": "missing-in-last-scan", "replacement": "
" } ], "localized": [ "name" ], "name": [ { "language_code": "en_us", "string": "Status" } ] } ] }