def do_restore(tarname):
# type: (str) -> None
console.verbose("Restoring from '%s'...\n", tarname)
if not os.path.exists(tarname):
raise MKGeneralException("Unable to restore: File does not exist")
for name, path, canonical_name, descr, is_dir in backup_paths():
absdir = os.path.abspath(path)
if is_dir:
basedir = absdir
filename = "."
if os.path.exists(absdir):
console.verbose(" Deleting old contents of '%s'\n", absdir)
# The path might point to a symbalic link. So it is no option
# to call shutil.rmtree(). We must delete just the contents
for f in os.listdir(absdir):
if f not in ['.', '..']:
try:
p = absdir + "/" + f
if os.path.isdir(p):
shutil.rmtree(p)
else:
os.remove(p)
except Exception as e:
console.warning(" Cannot delete %s: %s", p, e)
else:
basedir = os.path.dirname(absdir)
filename = os.path.basename(absdir)
canonical_path = basedir + "/" + canonical_name
if os.path.exists(canonical_path):
console.verbose(" Deleting old version of '%s'\n",
canonical_path)
os.remove(canonical_path)
if not os.path.exists(basedir):
console.verbose(" Creating directory %s\n", basedir)
os.makedirs(basedir)
console.verbose(" Extracting %s (%s)\n", descr, absdir)
tar = tarfile.open(tarname, "r:gz")
if is_dir:
subtar = tarfile.open(fileobj=tar.extractfile(name + ".tar"))
if filename == ".":
subtar.extractall(basedir)
elif filename in subtar.getnames():
subtar.extract(filename, basedir)
subtar.close()
elif filename in tar.getnames():
tar.extract(filename, basedir)
tar.close()
console.verbose("Successfully restored backup.\n")
def _snmp_scan(host_config,
on_error="ignore",
for_inv=False,
do_snmp_scan=True,
for_mgmt_board=False):
import cmk.base.inventory_plugins as inventory_plugins
# Make hostname globally available for scan functions.
# This is rarely used, but e.g. the scan for if/if64 needs
# this to evaluate if_disabled_if64_checks.
check_api_utils.set_hostname(host_config.hostname)
snmp.initialize_single_oid_cache(host_config)
console.vverbose(" SNMP scan:\n")
if not config.get_config_cache().in_binary_hostlist(
host_config.hostname, config.snmp_without_sys_descr):
for oid, name in [(".1.3.6.1.2.1.1.1.0", "system description"),
(".1.3.6.1.2.1.1.2.0", "system object")]:
value = snmp.get_single_oid(host_config,
oid,
do_snmp_scan=do_snmp_scan)
if value is None:
raise MKSNMPError(
"Cannot fetch %s OID %s. This might be OK for some bogus devices. "
"In that case please configure the ruleset \"Hosts without system "
"description OID\" to tell Check_MK not to fetch the system "
"description and system object OIDs." % (name, oid))
else:
# Fake OID values to prevent issues with a lot of scan functions
console.vverbose(
" Skipping system description OID "
"(Set .1.3.6.1.2.1.1.1.0 and .1.3.6.1.2.1.1.2.0 to \"\")\n")
snmp.set_single_oid_cache(host_config, ".1.3.6.1.2.1.1.1.0", "")
snmp.set_single_oid_cache(host_config, ".1.3.6.1.2.1.1.2.0", "")
found_check_plugin_names = []
if for_inv:
items = inventory_plugins.inv_info.items()
else:
items = config.check_info.items()
positive_found = []
default_found = []
for check_plugin_name, _unused_check in items:
if config.service_ignored(host_config.hostname, check_plugin_name,
None):
continue
else:
if for_inv and not inventory_plugins.is_snmp_plugin(
check_plugin_name):
continue
elif not for_inv and not cmk.base.check_utils.is_snmp_check(
check_plugin_name):
continue
section_name = cmk.base.check_utils.section_name_of(check_plugin_name)
# The scan function should be assigned to the section_name, because
# subchecks sharing the same SNMP info of course should have
# an identical scan function. But some checks do not do this
# correctly
if check_plugin_name in config.snmp_scan_functions:
scan_function = config.snmp_scan_functions[check_plugin_name]
elif section_name in config.snmp_scan_functions:
scan_function = config.snmp_scan_functions[section_name]
elif section_name in inventory_plugins.inv_info:
scan_function = inventory_plugins.inv_info[section_name].get(
"snmp_scan_function")
else:
scan_function = None
if scan_function:
try:
def oid_function(oid,
default_value=None,
cp_name=check_plugin_name):
value = snmp.get_single_oid(host_config,
oid,
cp_name,
do_snmp_scan=do_snmp_scan)
return default_value if value is None else value
result = scan_function(oid_function)
if result is not None and not isinstance(result, (str, bool)):
if on_error == "warn":
console.warning(
" SNMP scan function of %s returns invalid type %s."
% (check_plugin_name, type(result)))
elif on_error == "raise":
raise MKGeneralException("SNMP Scan aborted.")
elif result:
found_check_plugin_names.append(check_plugin_name)
positive_found.append(check_plugin_name)
except MKGeneralException:
# some error messages which we explicitly want to show to the user
# should be raised through this
raise
except Exception:
if on_error == "warn":
console.warning(
" Exception in SNMP scan function of %s" %
check_plugin_name)
elif on_error == "raise":
raise
else:
found_check_plugin_names.append(check_plugin_name)
default_found.append(check_plugin_name)
_output_snmp_check_plugins("SNMP scan found", positive_found)
if default_found:
_output_snmp_check_plugins("SNMP without scan function", default_found)
filtered = config.filter_by_management_board(host_config.hostname,
found_check_plugin_names,
for_mgmt_board,
for_discovery=True,
for_inventory=for_inv)
_output_snmp_check_plugins("SNMP filtered check plugin names", filtered)
snmp.write_single_oid_cache(host_config)
return sorted(filtered)
def warning(text):
# type: (str) -> None
g_configuration_warnings.append(text)
console.warning("\n%s", text, stream=sys.stdout)
def _snmp_scan(host_config,
on_error="ignore",
for_inv=False,
do_snmp_scan=True,
for_mgmt_board=False):
# type: (SNMPHostConfig, str, bool, bool, bool) -> Set[CheckPluginName]
import cmk.base.inventory_plugins as inventory_plugins # pylint: disable=import-outside-toplevel
# Make hostname globally available for scan functions.
# This is rarely used, but e.g. the scan for if/if64 needs
# this to evaluate if_disabled_if64_checks.
check_api_utils.set_hostname(host_config.hostname)
snmp.initialize_single_oid_cache(host_config)
console.vverbose(" SNMP scan:\n")
if not config.get_config_cache().in_binary_hostlist(
host_config.hostname, config.snmp_without_sys_descr):
for oid, name in [(".1.3.6.1.2.1.1.1.0", "system description"),
(".1.3.6.1.2.1.1.2.0", "system object")]:
value = snmp.get_single_oid(host_config,
oid,
do_snmp_scan=do_snmp_scan)
if value is None:
raise MKSNMPError(
"Cannot fetch %s OID %s. This might be OK for some bogus devices. "
"In that case please configure the ruleset \"Hosts without system "
"description OID\" to tell Check_MK not to fetch the system "
"description and system object OIDs." % (name, oid))
else:
# Fake OID values to prevent issues with a lot of scan functions
console.vverbose(
" Skipping system description OID "
"(Set .1.3.6.1.2.1.1.1.0 and .1.3.6.1.2.1.1.2.0 to \"\")\n")
snmp.set_single_oid_cache(".1.3.6.1.2.1.1.1.0", "")
snmp.set_single_oid_cache(".1.3.6.1.2.1.1.2.0", "")
if for_inv:
these_plugin_names = list(inventory_plugins.inv_info)
else:
# TODO (mo): stop converting to string!
these_plugin_names = [str(n) for n in config.registered_snmp_sections]
found_by_positive_result = set() # type: Set[CheckPluginName]
found_by_default = set() # type: Set[CheckPluginName]
for check_plugin_name in these_plugin_names:
if config.service_ignored(host_config.hostname, check_plugin_name,
None):
continue
if for_inv and not inventory_plugins.is_snmp_plugin(check_plugin_name):
continue
if not for_inv and not cmk.base.check_utils.is_snmp_check(
check_plugin_name):
continue
detection_spec = _get_detection_spec_from_plugin_name(
check_plugin_name, inventory_plugins.inv_info)
if detection_spec:
try:
def oid_function(oid,
default_value=None,
cp_name=check_plugin_name):
# type: (OID, Optional[DecodedString], Optional[CheckPluginName]) -> Optional[DecodedString]
value = snmp.get_single_oid(host_config,
oid,
cp_name,
do_snmp_scan=do_snmp_scan)
return default_value if value is None else value
if callable(detection_spec):
result = detection_spec(oid_function)
else:
result = _evaluate_snmp_detection(oid_function,
detection_spec)
if result is not None and not isinstance(result, (str, bool)):
if on_error == "warn":
console.warning(
" SNMP scan function of %s returns invalid type %s."
% (check_plugin_name, type(result)))
elif on_error == "raise":
raise MKGeneralException("SNMP Scan aborted.")
elif result:
found_by_positive_result.add(check_plugin_name)
except MKGeneralException:
# some error messages which we explicitly want to show to the user
# should be raised through this
raise
except Exception:
if on_error == "warn":
console.warning(
" Exception in SNMP scan function of %s" %
check_plugin_name)
elif on_error == "raise":
raise
else:
found_by_default.add(check_plugin_name)
_output_snmp_check_plugins("SNMP scan found", found_by_positive_result)
if found_by_default:
_output_snmp_check_plugins("SNMP without scan function",
found_by_default)
filtered = config.filter_by_management_board(
host_config.hostname,
found_by_positive_result | found_by_default,
for_mgmt_board,
for_discovery=True,
for_inventory=for_inv,
)
_output_snmp_check_plugins("SNMP filtered check plugin names", filtered)
snmp.write_single_oid_cache(host_config)
return filtered
def warning(text):
g_configuration_warnings.append(text)
console.warning("\n%s", text, stream=sys.stdout)
